Skip to main content

Documentation

Example Project Structure for a Python / PyPI Project

Installation

Note that this supports Python 3 ONLY

Basic Usage

Warning eggs are deprecated in favor of wheels, and not supported by pip.

This project is a sample template used to aggregate the process of:

  • Laying out a python project

  • Using setuptools build system to

    • to facilitate packaging Python projects

    • Python package and module definitions

    • Distribution package metadata

    • Project installation

Outline the process to

  • Create Python Eggs - a single-file importable distribution format

  • Automatically include all packages in your source tree, without listing them individually in setup.py

  • Automatically generate wrapper scripts or Windows (console and GUI) .exe files for any number of “main” functions in your project. (Note: this is not a py2exe replacement; the .exe files rely on the local Python installation.)

Command Reference

https://setuptools.readthedocs.io/en/latest/setuptools.html#command-reference

For example, to produce a source distribution, simply invoke:

>>>
python setup.py sdist

Detailed instructions to distribute a setuptools project can be found at Packaging project tutorials. https://packaging.python.org/tutorials/packaging-projects/#generating-distribution-archives

Before you begin, make sure you have the latest versions of setuptools and wheel:

>>>
python -m pip install --user --upgrade setuptools wheel

To build a setuptools project, run this command from the same directory where setup.py is located:

>>>
python setup.py sdist bdist_wheel

This will generate distribution archives in the dist directory.

Uploading to test.pypi.org

test.pypi.org

Before you upload the generated archives make sure you’re registered on https://test.pypi.org/account/register/.

You will also need to verify your email to be able to upload any packages. You should install twine to be able to upload packages:

>>>
python -m pip install --user --upgrade twine

Now, to upload these archives, run:

>>>
python -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*

To install your newly uploaded package example_pkg, you can use pip:

>>>
python -m pip install --index-url https://test.pypi.org/simple/ example_pkg

If you have issues at any point, please refer to Packaging project tutorials for clarification.

Credits

Patrick Shiel: github.com/patrickshiel

License

MIT License

Metadata

Release files for pyprojecttemplate 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyprojecttemplate 0.1.0
File Size Uploaded
pyprojecttemplate-0.1.0.tar.gz 3.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyprojecttemplate 0.1.0
File Interpreter ABI Platform
pyprojecttemplate-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 8.2 kB

Release files / pyprojecttemplate-0.1.0.tar.gz

Download URL pyprojecttemplate-0.1.0.tar.gz
Size 3.3 kB
Tags Source
SHA-256 checksum
How to use checksums
6ed3845b27ae772a585822389dbd17002e7e4fddac1d48eb2dbc334708b2783d
BLAKE2b-256 checksum
How to use checksums
78f1aca1e8c2690854c91969e811214eab34d502a68eac613bda2940f3eda82b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.8.0

Release files / pyprojecttemplate-0.1.0-py3-none-any.whl

Download URL pyprojecttemplate-0.1.0-py3-none-any.whl
Size 4.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
15f47bf3857a5efefb583e122d161bb3246ebfa15712db3cd723390a9c931767
BLAKE2b-256 checksum
How to use checksums
aac05b9a9e0fbd2483a5c1ea1265459d4d69ac4ce7cad4d46d55d8777df12f10
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/42.0.2 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.8.0

Release history Release notifications | RSS feed

0.2.0

3 release files

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page