|
1 | | -lib3mf (Python) |
2 | | -========= |
| 1 | +# lib3mf (Python) |
| 2 | + |
| 3 | +[](https://pypi.org/project/lib3mf/) |
| 4 | +[](https://pypi.org/project/lib3mf/) |
| 5 | +[](https://github.com/3MFConsortium/lib3mf/blob/main/LICENSE) |
| 6 | +[](https://github.com/3MFConsortium/lib3mf_python/actions) |
| 7 | +[](https://pypi.org/project/lib3mf/) |
| 8 | + |
3 | 9 |
|
4 | 10 | This repository will holds the lib3mf python library to be published in PyPI. |
5 | | -After each release in lib3mf repository, one simply needs to run the `prepare_pypi_release.py` command as follows |
6 | 11 |
|
| 12 | +## Preparing for release |
| 13 | + |
| 14 | +After each release in lib3mf repository, one simply needs to run the `prepare_pypi_release.py` command as follows |
7 | 15 |
|
8 | 16 | ```shell |
9 | | -python prepare_pypi_release 2.3.2 |
| 17 | +python prepare_pypi_release 2.4.1a1 |
10 | 18 | ``` |
11 | 19 |
|
12 | 20 | This command automatically updates all necessary artifacts based on the version number. |
13 | 21 | Once completed, simply push the changes to Git. |
14 | 22 |
|
| 23 | + |
| 24 | +## Manually building python wheels |
15 | 25 | To manually build the package, run: |
16 | 26 |
|
17 | 27 | ```shell |
18 | 28 | python build_wheels.py |
19 | 29 | ``` |
20 | 30 |
|
21 | | -This script automatically detects the platform and builds the appropriate wheel. |
| 31 | +This script automatically detects the platform and builds the appropriate wheel. |
| 32 | + |
| 33 | + |
| 34 | +## Automatic python wheel building and publishing |
| 35 | + |
| 36 | +Every commit automatically builds and tests the python wheels for all 3 platforms. |
| 37 | +However, to publish them to PyPI, the commit message should contain the string `PUBLISH_NOW` |
| 38 | +Without this string, deployment to PyPI will be skipped. |
0 commit comments