Skip to main content

Example boilerplate for a simple Python project

Project description

Example Python project

Tests status PyPI publishing status PyPI version OSI license

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.

  1. Install necessary dependencies.
pip3 install setuptools twine build
  1. Generate distribution archives (bundle package).
python3 -m build
  1. Upload the distribution archives to test-pypi as follows.
python3 -m twine upload --repository testpypi dist/*
  1. 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


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 details)

Uploaded Source

Built Distribution

my_project_andre-0.1.1-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file my-project-andre-0.1.1.tar.gz.

File metadata

  • Download URL: my-project-andre-0.1.1.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for my-project-andre-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8cd711a8dc016aed7ce5818dda269e21e5088bfc9e1bedd466076d5d0a7874c8
MD5 c7bdfeb2610825d81e2ca5d4306b6d06
BLAKE2b-256 3422c0c05f592d0a01dd814673e82ec17b82bd1c0c57b4e0a5075391e3695ec3

See more details on using hashes here.

Provenance

File details

Details for the file my_project_andre-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for my_project_andre-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3697e0bb9c04d92f401a75ef3ca736cd1f17140d452578ecdcbbdda0d6abc808
MD5 48a460fe67f7a024b5246815bdb9e573
BLAKE2b-256 9cea42725e67b0fee6b523386f21e89bb2b44105330bc7cf74743f560cf6ac71

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page