Add link to python binding.

This commit is contained in:
Syoyo Fujita
2022-08-12 02:31:42 +09:00
parent 111e098cee
commit 82992be656
2 changed files with 57 additions and 0 deletions

View File

@@ -242,6 +242,12 @@ mkdir -p ~/.config/blender/2.93/scripts/addons/modules
* [ ] Write parser based on the schema definition.
* [ ] Support big endian architecture.
## Python binding and prebuit packages
Python binding and prebuilt packages(uploadded on PyPI) are provided.
See [python/README.md](python/README.md) and [doc/python_binding.md](doc/python_binding.md) for details.
## Fuzzing test
See `tests/fuzzer/`

51
doc/python_binding.md Normal file
View File

@@ -0,0 +1,51 @@
# TinyUSDZ Python binding and prebuilt package.
TinyUSDZ provides pre-built Python binding of TinyUSDZ for Windows, Linux and macOS through PyPI.
## Requirements
* Python 3.8+
* Pip 19.3+
TinyUSDZ uses C++14, so on Linux, minimal supported `manylinux` version is `manylinux2014`.
(`manylinux2010` and `manylinux1` are not supported).
## Install
```
$ python -m pip install -U tinyusdz
```
## Build from source
`pyproject.toml` is provided, so you can build Python binding by `python-build`
```
$ python -m pip install build # if you didn't installed `build` package.
$ python -m build
```
TinyUSDZ python binding uses `scikit-build` to build Python module(and `python-build` is just involing this `scikit-build` to build a package), which provides native support of cmake.
You can alternatively build TinyUSDZ python binding by:
```
$ python setup.py build
$ python setup.py bdist_wheel
```
NOTE: you may need to delete/clean intermediate files/directories generated by `scikit-build`(e.g. `python/tinyusdz.egg-info`)
## Exmaple
T.B.W.
EoL.
## Develper note
Binary wheels are built with cibuildwheel and Github Action.
See [github actions file](../.github/workflows/wheels.yml)