A sample Python project
Project description
My notes:
Register for an account on test.pypi, and get an API token.
# update the pyproject.toml [project] name (to be the package name)
python3 -m pip install --upgrade build
# go to folder that contains pyproject.toml and run this:
python3 -m build
python3 -m pip install --upgrade twine
# go folder containing dist and run this:
python3 -m twine upload --repository testpypi dist/*
# for username, literally enter username as __token__
# for password, use your API key from your test.pypi account, including pypi- prefix
# https://test.pypi.org/search/?q=example_package_hchiam
# https://test.pypi.org/project/example-package-hchiam/
(more steps if you want to test the test-only version of your package: https://test.pypi.org/project/example-package-hchiam/)
To upload the production-ready version of your package: (pypi requires a separate registration and API key set up from the test.pypi site)
python3 -m twine upload dist/*
# for username, still literaly enter __token__
# for password, use your other API key from your pypi account, including pypi- prefix
# https://pypi.org/search/?q=example_package_hchiam
# https://pypi.org/project/example-package-hchiam/
https://pypi.org/project/example-package-hchiam/
# python3 -m pip install [your-package]
python3 -m pip install example_package_hchiam
/tests/test_example.py
shows a good example of how the package will be used by users, where you can see a method from an inner/non-__init__
file, e.g.:
from example_package_hchiam.example import add_one
Streamlined thereafter:
# update code
# update pyproject.toml version number
# remove the old .whl and .gz files
rm -rf dist
python3 -m build
python3 -m twine upload --repository testpypi dist/*
python3 -m twine upload dist/*
python3 -m pip install example_package_hchiam
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for example_package_hchiam-0.0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ac9dca134e8f693eac18865170f3553b80d4c243b19061e8bb0125a9f4ac297 |
|
MD5 | 987b2deda6cfa4eca8e2715b0a048d5c |
|
BLAKE2b-256 | 6c549188a0c4e94abc3aa218c39d1e33c42210b9adf92464eee348ed479a6058 |
Close
Hashes for example_package_hchiam-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 16574a909d5c96df16017991738bd068fefc3b00bdbb4ed343667fbdc66ac596 |
|
MD5 | c96e07fd9e6a9eebdf974a11bcad5aed |
|
BLAKE2b-256 | 96f1b94b4a06e193a085a3634ab4d855292e3e8adc4f265f9a8206e336c3afda |