Skip to content

Commit c141df8

Browse files
Update README.md
1 parent 9a28a10 commit c141df8

1 file changed

Lines changed: 22 additions & 5 deletions

File tree

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,38 @@
1-
lib3mf (Python)
2-
=========
1+
# lib3mf (Python)
2+
3+
[![PyPI Version](https://img.shields.io/pypi/v/lib3mf)](https://pypi.org/project/lib3mf/)
4+
[![PyPI Downloads](https://img.shields.io/pypi/dm/lib3mf)](https://pypi.org/project/lib3mf/)
5+
[![License](https://img.shields.io/pypi/l/lib3mf)](https://github.com/3MFConsortium/lib3mf/blob/main/LICENSE)
6+
[![Build Status](https://github.com/3MFConsortium/lib3mf_python/actions/workflows/python-package.yml/badge.svg)](https://github.com/3MFConsortium/lib3mf_python/actions)
7+
[![Python Versions](https://img.shields.io/pypi/pyversions/lib3mf)](https://pypi.org/project/lib3mf/)
8+
39

410
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
611

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
715

816
```shell
9-
python prepare_pypi_release 2.3.2
17+
python prepare_pypi_release 2.4.1a1
1018
```
1119

1220
This command automatically updates all necessary artifacts based on the version number.
1321
Once completed, simply push the changes to Git.
1422

23+
24+
## Manually building python wheels
1525
To manually build the package, run:
1626

1727
```shell
1828
python build_wheels.py
1929
```
2030

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

Comments
 (0)