v0.0.5

Author: SebastiaAgramunt

README.md

@@ -1,5 +1,7 @@
-# Python CPP Boilerplate
+# Python C++ package boilerplate
 
+A minimal, cross-platform template for building Python packages with C++ extensions using pybind11.
+It includes a reproducible development environment, testing and linting setup, and automated multi-platform wheel building (Linux, macOS, Windows, x86_64 and arm64) via GitHub Actions.
 
 ## Compile and install the package
 
@@ -17,6 +19,25 @@ Then compile C++ bindings and install with pip
 .venv/bin/python -m pip install .
 ```
 
+## Install from wheel
+
+Wheels are published on github, to install a compiled version of the package published on github, instead of the last command of the previous section (install from source), run this
+
+```bash
+USER=sebastiaagramunt
+REPO=python-boilerplate
+PACKAGE_NAME=package_example
+PYTHON_VERSION=cp313
+VERSION=v0.0.5
+
+# print your system, change SYSTEM variable accordingly
+python3 -c "import sysconfig; print(sysconfig.get_platform())"
+SYSTEM=macosx_11_0_arm64
+
+# install from wheel
+.venv/bin/python -m pip install "https://github.com/${USER}/${REPO}/releases/download/${VERSION}/${PACKAGE_NAME}-${VERSION/#v/}-${PYTHON_VERSION}-${PYTHON_VERSION}-${SYSTEM}.whl"
+```
+
 ## Run an example
 
 To check that this is working try importing the package and running a script
@@ -38,7 +59,7 @@ Run tests
 .venv/bin/mypy src
 ```
 
-## Build wheels
+## Build wheels locally
 
 Locally you can build the wheels with
 
@@ -66,14 +87,16 @@ In my system it creates the wheel in `dist`
 dist/package_example-0.0.1-cp313-cp313-linux_aarch64.whl
 ```
 
-## CI-CD for testing and wheel publishing
+## Build & test wheels (Github Actions CI/CD)
 
 The software is tested on GitHub Actions for python versions `3.10-3.13`, architectures `x86` and `arm64` and on `ubuntu`, `macos` and `windows` operating systems. On each push in a branch the actions in `.github/workflows/build-wheels.yml` is kicked off. This action tests and publishes the wheel internally.
 
 To publish the wheels just tag the release, go to master branch and check the version in `__version__` variable of `setup.py`. E.g. for the initial commit the version is `0.0.1`. Then we would run
 
 ```bash
-VERSION=0.0.1
+VERSION=0.0.5
 git tag -a v${VERSION} -m "v${VERSION}"
 git push origin v${VERSION}
 ```
+To see the relase published in releases section on the same repository. E.g. [Tagged version v0.0.5](https://github.com/SebastiaAgramunt/python-boilerplate/releases/tag/v0.0.5)
+

setup.py

@@ -3,7 +3,7 @@
 from pathlib import Path
 import sysconfig
 
-__version__ = '0.0.3'
+__version__ = '0.0.5'
 
 REPO_PATH = Path(__file__).resolve().parent