Skip to content

Commit 33d4851

Browse files
committed
update docs
1 parent f008db5 commit 33d4851

File tree

1 file changed

+12
-24
lines changed

1 file changed

+12
-24
lines changed

bindings/python/README.md

+12-24
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,23 @@
11
# gtars
22

3-
This is a python wrapper around the `gtars` crate. It provides an easy interface for using `gtars` in python. It is currently in early development, and as such, it does not have a lot of functionality yet, but new tools are being worked on right now.
3+
This is a Python package that wraps the `gtars` crate so you can call gtars code from Python.
44

5-
## Installation
5+
Documentation for Python bindings is hosted at: https://docs.bedbase.org/gtars/
66

7-
You can get `gtars` from PyPI:
7+
## Brief instructions
88

9-
```bash
10-
pip install gtars
11-
```
12-
13-
## Usage
14-
15-
Import the package, and use the tools:
16-
```python
17-
import gtars as gt
18-
19-
gt.prune_universe(...)
20-
```
21-
## Developer docs
22-
23-
To build for development:
9+
To install the development version, you'll have to build it locally. Build Python bindings like this:
2410

25-
```bash
11+
```console
2612
cd bindings/python
27-
maturin build --release
13+
maturin build --interpreter 3.11 --release
2814
```
2915

3016
Then install the local wheel that was just built:
3117

32-
```
33-
version=`grep '^version =' Cargo.toml | cut -d '"' -f 2`
34-
pip install --force-reinstall target/wheels/gtars-${version}-cp312-cp312-manylinux_2_38_x86_64.whl
35-
```
18+
```console
19+
gtars_version=`grep '^version =' Cargo.toml | cut -d '"' -f 2`
20+
python_version=$(python --version | awk '{print $2}' | cut -d '.' -f1-2 | tr -d '.')
21+
wheel_path=$(find target/wheels/gtars-${gtars_version}-cp${python_version}-cp${python_version}-*.whl)
22+
pip install --force-reinstall ${wheel_path}
23+
```

0 commit comments

Comments
 (0)