Skip to main content

A sample Python project

Project description

Requirements

python3 -m pip install --upgrade build
python3 -m pip install --upgrade twine
python3 -m pip install --upgrade setuptools wheel

Download repository:

git clone https://github.com/johanneskruse/pypi_template.git

Upload:

In pyproject.toml you can set the name of the pacakage

Run the following to upload:

Packaging Python Projects

Generating distribution archives

Stand inside the project, i.e.

cd pypi_template

Next build the package:

python3 -m build

This command should output a lot of text and once completed should generate two files in the dist directory:

dist/
├── sampleproject-0.0.1-py3-none-any.whl
└── sampleproject-0.0.1.tar.gz

Uploading the distribution archives

twine upload dist/*

Go to https://pypi.org/ to see the package!

Inspiration

setup.py vs setup.cfg in Python

sample git repo project

Packaging Python Projects

TODO:

  • Setup with pyproject.toml file
  • Note that if you want to install packages in editable mode (i.e. by running pip install -e .) you must have a valid setup.py file apart from setup.cfg and pyproject.toml. TRY TO RUN INSTEAD: pip install -e . -f .

Acronym Generator (help generate the name)

https://acronymify.com/

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

wombats-0.0.1.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wombats-0.0.1-py3-none-any.whl (2.4 kB view details)

Uploaded Python 3

File details

Details for the file wombats-0.0.1.tar.gz.

File metadata

  • Download URL: wombats-0.0.1.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for wombats-0.0.1.tar.gz
Algorithm Hash digest
SHA256 ceff442c25ad1cb08570325b221816aa3e418cfb01f7c84758806e17e800de97
MD5 4f1e0cf98e6a4a37337a13c8f68e98d2
BLAKE2b-256 f8d1a54892ad0d0b5cd4a49ad4e661c5b31b7afcc22b14975844212efe9a2c27

See more details on using hashes here.

File details

Details for the file wombats-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: wombats-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 2.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for wombats-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3fb2a9a60190c04f08b102745e7d3b8c56d7f408bc173b2eedc19dae0a27c641
MD5 58708092de8cbda595dcba79665f247b
BLAKE2b-256 597405a13d01ad9fbbd64919dfda56d6bee746c0bc6664196e56936817eeea49

See more details on using hashes here.

Supported by

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