Home

Welcome to the dotz wiki!

Release to PyPI

Use these steps to build a release and upload it to PyPI.

1. Ensure your working tree is clean and update the version in dotz.py.
2. Create and activate a virtual environment.
3. Install release tooling.
4. Build and validate the package.
5. Upload to TestPyPI first, then PyPI.

# from project root
python3 -m venv .venv
source .venv/bin/activate

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

# clean old artifacts
rm -rf dist/ build/ *.egg-info

# build sdist + wheel
python -m build

# verify metadata and package archives
python -m twine check dist/*

# upload to TestPyPI (recommended first)
python -m twine upload --repository testpypi dist/*

# test install from TestPyPI
python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple dot

# upload to PyPI
python -m twine upload dist/*

Tagging a Release

After bumping the version in setup.py:

git add setup.py README.md pyproject.toml
git commit -m "Release v0.1.1"
git tag v0.1.1
git push origin main --tags

PyPI Credentials

• Preferred: use an API token as password with username __token__.
• Store credentials in ~/.pypirc or enter them when prompted by twine.
• If you use 2FA on PyPI, API tokens are required for uploads.