orisys-sdk/docs/publishing.md

Publishing Orisys to PyPI

This document covers the Linux manylinux binary wheel path (Nuitka-compiled orisys for CPython 3.10 / 3.11 / 3.12). Windows wheels are still built on Windows hosts; they cannot be produced inside the manylinux container.

Why Docker?

PyPI rejects wheels tagged manylinux_x86_64 (missing glibc ABI version). A compliant tag looks like:

orisys-0.4.2-cp310-cp310-manylinux_2_28_x86_64.whl
orisys-0.4.2-cp311-cp311-manylinux_2_28_x86_64.whl
orisys-0.4.2-cp312-cp312-manylinux_2_28_x86_64.whl

Those tags are produced by building inside the official manylinux image and running auditwheel repair. On Windows, use Docker Desktop in Linux container mode.

Note: we use manylinux_2_28_x86_64 (not 2014). Recent NumPy/SciPy no longer provide manylinux2014 wheels and fail to build from source on that older GCC.

Prerequisites

1. Docker Desktop installed and running (Linux containers, not Windows containers).
2. Repository checked out locally (this tree is bind-mounted into the container).
3. Version bumped in src/orisys/__init__.py (__version__) before every upload. PyPI never allows re-uploading the same filename/version.
4. PyPI / TestPyPI project-scoped API tokens (never commit tokens or .pypirc with secrets).

Quick Docker check:

docker version --format "{{.Server.Os}}"
# expect: linux
docker run --rm hello-world

Build manylinux wheels (3.10 / 3.11 / 3.12)

From the repository root:

python build/run.py manylinux

Or call the Docker helper directly:

.\build\wheel\docker\run.ps1

Default builds all three ABIs. To build a subset:

python build/run.py manylinux -PythonVersions 3.10,3.12
python build/run.py manylinux -PythonVersions 3.11

What this does:

1. Builds orisys-manylinux from build/wheel/docker/Dockerfile.manylinux (quay.io/pypa/manylinux_2_28_x86_64 with Nuitka/auditwheel in cp310/cp311/cp312).

2. Runs build/wheel/docker/entrypoint.sh, which loops:

   /opt/python/cp310-cp310/bin/python build/wheel/build.py --target pypi-linux
   /opt/python/cp311-cp311/bin/python build/wheel/build.py --target pypi-linux
   /opt/python/cp312-cp312/bin/python build/wheel/build.py --target pypi-linux
   

3. For each ABI: Nuitka compile → wheel → auditwheel repair → isolated smoke test.

4. Artifacts land in:

   • dist/repaired/orisys-*-manylinux_2_28_x86_64.whl (upload candidates)
   • SDK/<version>/ (same compliant wheels)

Expect roughly 3× the wall time of a single-ABI build.

Rebuild without refreshing the image:

python build/run.py manylinux -SkipImageBuild

Equivalent manual docker invocation:

docker build -f build/wheel/docker/Dockerfile.manylinux -t orisys-manylinux .
docker run --rm `
  -e ORISYS_BUILD_TARGET=pypi-linux `
  -e ORISYS_PYTHON_TAGS=cp310-cp310,cp311-cp311,cp312-cp312 `
  -v "${PWD}:/src" `
  orisys-manylinux

Acceptance checks before upload

• Each filename contains cp310 / cp311 / cp312 and manylinux_2_28_x86_64 (or another accepted manylinux tag such as manylinux_2_17_x86_64).
• Isolated smoke test printed public API imports OK for every ABI.
• Do not upload any wheel still tagged linux_x86_64 or bare manylinux_x86_64.

Optional re-verify on a Linux machine:

python build/run.py verify dist/repaired/orisys-*-cp310-cp310-manylinux_*.whl

Promote: TestPyPI then PyPI

Install upload tooling in a clean environment:

python -m pip install --upgrade twine

1. Upload to TestPyPI

$env:TWINE_USERNAME = "__token__"
$env:TWINE_PASSWORD = "<TestPyPI API token>"

python -m twine check dist/repaired/*.whl
python -m twine upload --repository testpypi dist/repaired/*.whl

Install from TestPyPI in a fresh venv (pull runtime deps from real PyPI), testing each Python you care about:

py -3.10 -m venv .venv-testpypi310
.\.venv-testpypi310\Scripts\Activate.ps1
python -m pip install --index-url https://test.pypi.org/simple/ `
  --extra-index-url https://pypi.org/simple `
  "orisys==<version>"
python -c "import orisys; print(orisys.__version__)"

2. Upload the same artifacts to PyPI

Only after TestPyPI install/import succeeds:

$env:TWINE_USERNAME = "__token__"
$env:TWINE_PASSWORD = "<PyPI API token>"

python -m twine upload dist/repaired/*.whl

Prefer CI Trusted Publishing (OIDC) for production uploads so long-lived tokens are not stored on developer machines.

Related local targets

Command	Purpose
python build/run.py wheel	Preferred wheel builder launcher
python build/wheel/build.py	Direct wheel builder (current host)
python build/run.py wheel --target pypi-linux	Linux-only; requires manylinux + CPython 3.10–3.12
python build/run.py wheel-win	Windows wheels for py310/py311/py312 conda envs
python build/run.py manylinux	manylinux Docker runner
python build/run.py gui finger	ORY-FINGER standalone GUI
python -m build	Pure-Python / sdist path from pyproject.toml (no Nuitka)

See also build/README.md for the target-oriented layout.

Windows binary wheels and Linux manylinux wheels must be built on their respective platforms. Never rename a platform tag to bypass PyPI validation.