Python packaging cheatsheet

python_packaging.md

Create

First time only.

mkdir myproject
cd myproject/
python -m venv venv
source venv/bin/activate
git clone [email protected]:username/myproject.git
cd myproject/
python setup.py install

Activate environment

source venv/bin/activate

Install dependencies

First time only!

pip install django black tox sphinx sphinx-autobuild sphinx_rtd_theme wheel twine

Update

Make changes.

Test

django-admin test myproject.tests --settings="myproject.tests.settings"

Lint

black .

Document

sphinx-autobuild docs/ docs/_build_html

Make changes to docs/<file>.rst. Confirm at 127.0.0.1:8000.

Commit

git add .
git commit -m "Added feature"
git push origin main

Integrate

Confirm continuous integration results.

Commit

nano setup.py  # change point release
git add .
git commit -m "Bumped version"
git push origin main

Release

python setup.py sdist bdist_wheel  # maybe use `python -m build` instead?
twine check dist/*
twine upload -r testpypi dist/*
twine upload dist/*

Exit environment

deactivate

Sources

• Packaging Python Projects
• Creating a Source Distribution
• Why you shouldn't invoke setup.py directly
• build