Example Python project

Generate cool badges with badgen, shields, or the standard GitHub workflow badges.

This repo contains boilerplate configs for python projects, including:

• vanilla setup.py to bundle and install a python package;
• publishing package to PyPI on CI;
• running tests on CI;
• general folder structure.

Publishing to PyPI locally

Python reference here, and twine reference here.

0. Install necessary dependencies.

pip3 install setuptools twine build

1. Generate distribution archives (bundle package).

python3 -m build

2. Upload the distribution archives to test-pypi as follows.

python3 -m twine upload --repository testpypi dist/*

3. If everything looks OK, upload the distribution archives to the official PyPI repo.

python3 -m twine upload dist/*

Note When prompted for credentials use __token__ for the username and your generated api token as the password.

Installing

After publishing your project, you can now install it with pip as follows (optionally, add the test-pypi url):

pip3 install my-project-andre [--index-url https://test.pypi.org/simple/]

Substitute my-project-andre with whatever unique project name you chose in setup.py.