Skip to main content

A sample Python project

Python Logo

A sample project that exists as an aid to the Python Packaging User Guide's Tutorial on Packaging and Distributing Projects.

This project does not aim to cover best practices for Python project development as a whole. For example, it does not provide guidance or tool recommendations for version control, documentation, or testing.

The source for this project is available here.

The metadata for a Python project is defined in the pyproject.toml file, an example of which is included in this project. You should edit this file accordingly to adapt this sample project to your needs.


This is the README file for the project.

The file should use UTF-8 encoding and can be written using reStructuredText or markdown with the appropriate key set. It will be used to generate the project webpage on PyPI and will be displayed as the project homepage on common code-hosting services, and should be written for that purpose.

Typical contents for this file would include an overview of the project, basic usage examples, etc. Generally, including the project changelog in here is not a good idea, although a simple “What's New” section for the most recent version may be appropriate.

Release files for sampleproject 4.0.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 sampleproject 4.0.0
File Size Uploaded
sampleproject-4.0.0.tar.gz 5.8 kB Details

Built distribution (wheel)

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

Total release size: 10.4 kB

Release files / sampleproject-4.0.0.tar.gz

Download URL sampleproject-4.0.0.tar.gz
Size 5.8 kB
Tags Source
SHA-256 checksum
How to use checksums
0ace7980f82c5815ede4cd7bf9f6693684cec2ae47b9b7ade9add533b8627c6b
BLAKE2b-256 checksum
How to use checksums
488cc18d25735962870ccb6d1cd2ac7bde40008a332211055e260cb7ec4c6bab
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 6, 2024.

Transparency log

Release files / sampleproject-4.0.0-py3-none-any.whl

Download URL sampleproject-4.0.0-py3-none-any.whl
Size 4.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c23e447ea90d796d1e645c35c4b2de125040add12a845825546f91c93f391b6b
BLAKE2b-256 checksum
How to use checksums
d773c16e5f3f0d37c60947e70865c255a58dc408780a6474de0523afd0ec553a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/5.1.1 CPython/3.12.7

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 6, 2024.

Transparency log

Release history Release notifications | RSS feed

This release

4.0.0 This release

2 release files

3.0.0

2 release files

2.0.0

2 release files

1.3.1

3 release files

1.3.0

2 release files

1.2.0

2 release files

1.0

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