https://github.com/nmwsharp/polyscope-py
Python bindings for Polyscope
https://github.com/nmwsharp/polyscope-py
Last synced: 8 months ago
JSON representation
Python bindings for Polyscope
- Host: GitHub
- URL: https://github.com/nmwsharp/polyscope-py
- Owner: nmwsharp
- License: mit
- Created: 2019-10-02T11:06:15.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-10-06T03:31:12.000Z (8 months ago)
- Last Synced: 2025-10-06T05:42:04.516Z (8 months ago)
- Language: Python
- Size: 530 KB
- Stars: 49
- Watchers: 5
- Forks: 21
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# polyscope-py
Python bindings for Polyscope. https://polyscope.run/py
[](https://github.com/nmwsharp/polyscope-py/actions)
[](https://github.com/nmwsharp/polyscope-py/actions)
[](https://github.com/nmwsharp/polyscope-py/actions)
[](https://pypi.org/project/polyscope/)
[](https://anaconda.org/conda-forge/polyscope)
This library is a python wrapper and deployment system. The core library lives at https://github.com/nmwsharp/polyscope. See documentation at https://polyscope.run/py.
To contribute, check out the [instructions here](https://polyscope.run/about/contributing/).
### Installation
```
python -m pip install polyscope
```
or
```
conda install -c conda-forge polyscope
```
polyscope-py should work out-of-the-box on any combination of Python 3.7-3.12 and Linux/macOS/Windows. Your graphics hardware must support OpenGL >= 3.3 core profile.
## For developers
This repo is configured with CI on github actions.
- By default, all commits to the main branch build & run tests. Use `[ci skip]` to skip this.
- Tagging a commit with `[ci build]` causes it to also build all precompiled wheels on a matrix of platforms to ensure the build scripts succeed.
- Tagging a commit with `[ci publish]` causes it to build all precompiled wheels on a matrix of platforms AND upload them to pypi index
### Deploy a new version
- Commit the desired version to the `master` branch. Use the `[ci build]` string in the commit message to trigger builds, which should take about an hour.
- Watch the github actions builds to ensure all wheels build successfully. The resulting binaries will be saved as artifacts if you want try test with them.
- While you're waiting, update the docs, including the changelog.
- Update the version string in `setup.py` to the new version number. When you commit, include the string `[ci publish]`, which will kick of a publish job to build wheels again AND upload them to PyPI.
- If something goes wrong with the build & publish, you can manually retry by pushing any new commit with "[ci publish]" in the message.
- Create a github release. Tag the release commit with a tag like `v1.2.3`, matching the version in `setup.py`
- Update the conda builds by committing to the [feedstock repository](https://github.com/conda-forge/polyscope-feedstock). This generally just requires bumping the version number and updating the hash in `meta.yml`. Since `meta.yml` is configured to pull source from PyPi, you can't do this until after the source build has been uploaded from the github action.