Example boilerplate for a simple Python project
Project description
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.
- Install necessary dependencies.
pip3 install setuptools twine build
- Generate distribution archives (bundle package).
python3 -m build
- Upload the distribution archives to test-pypi as follows.
python3 -m twine upload --repository testpypi dist/*
- 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.
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
my-project-andre-0.1.1.tar.gz
(15.6 kB
view hashes)
Built Distribution
Close
Hashes for my_project_andre-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3697e0bb9c04d92f401a75ef3ca736cd1f17140d452578ecdcbbdda0d6abc808 |
|
MD5 | 48a460fe67f7a024b5246815bdb9e573 |
|
BLAKE2b-256 | 9cea42725e67b0fee6b523386f21e89bb2b44105330bc7cf74743f560cf6ac71 |