Publishing a Python Distribution Package in a Repository: Difference between revisions
| Line 71: | Line 71: | ||
To verify it works, you can use <code>pip</code> to download it. | To verify it works, you can use <code>pip</code> to download it. | ||
==<tt>pypi.org</tt>== | ===<tt>pypi.org</tt>=== | ||
Create an account, if you don't have one, for https://pypi.org | Create an account, if you don't have one, for https://pypi.org | ||
Revision as of 02:39, 9 April 2024
External
Internal
Overview
Procedure
Create the Project Layout
The project is aimed at publishing a Python package, which contains a library. The layout and required initialization work is described here:
Since we're aiming at publishing a library, the package will probably need an __init__.py but not a __main__.py.
Choose a Build Backend
Tools like pip or build do not convert the source into a distribution packages, they're just build frontends that delegate the process to a build backend. Several build backends are available, this example uses Hatchling.
Create pyproject.toml
More details:
Create the Distribution Archives
./.venv/bin/python -m pip install --upgrade build
Run the following command from the directory where the pyproject.toml is located:
./.venv/bin/python -m build
* Creating isolated environment: venv+pip... * Installing packages in isolated environment: - hatchling * Getting build dependencies for sdist... * Building sdist... * Building wheel from sdist * Creating isolated environment: venv+pip... * Installing packages in isolated environment: - hatchling * Getting build dependencies for wheel... * Building wheel... Successfully built ofddi-0.1.0.tar.gz and ofddi-0.1.0-py3-none-any.whl
The files are placed under the dist directory.
The tar.gz while is the source distribution, while the .whl is a built distribution.
Upload the Distribution Archives
test.pypi.org
Create an account, if you don't have one, for https://test.pypi.org/ at https://test.pypi.org/account/register/
Create an API token here: https://test.pypi.org/manage/account/#api-tokens
Install twine as described here:
Install the archives under dist:
.venv/bin/python -m twine upload --repository testpypi dist/*
Use __token__ as username and the API token as password. Alternatively, the program may ask directly for the API Token. Alternatively, configure it in the file:
Once uploaded, they can be viewed at: https://test.pypi.org/project/<project-name>/<version>/ (https://test.pypi.org/project/ofddi/0.1.0/)
To verify it works, you can use pip to download it.
pypi.org
Create an account, if you don't have one, for https://pypi.org
Create an API token.
Install the archives under dist:
.venv/bin/python -m twine upload dist/*
Use __token__ as username and the API token as password. Alternatively, the program may ask directly for the API Token. Alternatively, configure it in the file:
Once uploaded, they can be viewed at: https://pypi.org/project/<project-name>/<version>/ (https://pypi.org/project/ofddi/0.1.0/)
To verify it works, you can use pip to download it.