Skip to content

PUBLISHING.md

Latest commit

 

History

History
51 lines (33 loc) · 1.59 KB

PUBLISHING.md

File metadata and controls

51 lines (33 loc) · 1.59 KB

Publishing the SDK

Prerequisites

  • Python 3.9+
  • A Test PyPI API token (for test uploads) or PyPI API token (for production), from the account settings on test.pypi.org or pypi.org.
  • With API tokens, the username is always __token__ and the password is the token string (starts with pypi-).

Build

From the repository root:

python -m pip install --upgrade pip build twine
python -m build

This creates dist/*.whl and dist/*.tar.gz.

Publish to Test PyPI (token via environment variables)

Use TWINE_USERNAME and TWINE_PASSWORD (same pattern as export TWINE_PASSWORD=... for non-interactive uploads):

export TWINE_USERNAME=__token__
export TWINE_PASSWORD=pypi-your-testpypi-api-token-here

twine upload --repository-url https://test.pypi.org/legacy/ dist/*

Replace pypi-your-testpypi-api-token-here with your real Test PyPI token. Do not commit the token or paste it into the repo.

One-shot (single line, shell):

TWINE_USERNAME=__token__ TWINE_PASSWORD=pypi-your-token-here twine upload --repository-url https://test.pypi.org/legacy/ dist/*

Publish to production PyPI

export TWINE_USERNAME=__token__
export TWINE_PASSWORD=pypi-your-pypi-api-token-here

twine upload dist/*

Notes

  • Version: Each upload must use a new version in pyproject.toml / setup.py if that version was already published.
  • GitHub Actions: The workflow uses the TEST_PYPI_API_TOKEN / PyPI secrets instead of local export; behavior is equivalent to token-based upload.