Skip to content

Commit

Permalink
Merge pull request #14 from gfinol/update-docs
Browse files Browse the repository at this point in the history
Update python bindings instructions
  • Loading branch information
tkaitchuck authored Jan 9, 2024
2 parents fe6818c + 39ee850 commit ddeedb5
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions PythonBinding.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@

1. Ensure `cargo build` works fine.
2. There are two ways of running generating bindings. This describes the steps where maturin is manually installed.
- Manually install [maturin](https://github.com/PyO3/maturin) via `pip install maturin`
- `maturin build --release --no-sdist --strip --manylinux off` This command auto detects the python interpreter and uses it. To
- Manually install [maturin](https://github.com/PyO3/maturin) via `pip install maturin==0.14`
- `maturin build --release --strip --manylinux off` This command auto detects the python interpreter and uses it. To
specify a specific interpreter using `--interpreter` option.
- `maturin sdist` to generate the source distribution.
3. Steps to generate bindings using a docker approach.
- `docker run --rm -v --release --no-sdist --strip --manylinux off`
- `docker run --rm -v --release --strip --manylinux off`
4. After the bindings are generated by either 2 or 3 the next step is to publish the artifacts.
- The artifacts can be published via [twine](https://github.com/pypa/twine)
- `pip install twine`
- `twine upload -r testpypi target/*` this command uploads the artifacts to test.pypi
- `twine upload target/*` this command uploads the artifacts to pypi.
- The artifacts can be published via [maturin](https://github.com/PyO3/maturin)
- `maturin publish -b pyo3 -p XXX -u YYY -r https://test.pypi.org/legacy/` this publishes the bindings to test.pypi
- `maturin publish -b pyo3 -p XXX -u YYY` This publishes the bindings to pypi.
- `maturin publish -b pyo3 -p XXX -u YYY` This publishes the bindings to pypi.

0 comments on commit ddeedb5

Please sign in to comment.