packaging.python.orgPython Packaging User Guide

Contents Menu Expand Light mode Dark mode Auto light/dark mode Hide navigation sidebar Hide table of contents sidebar Toggle site navigation sidebar Toggle Light / Dark / Auto color theme Toggle table of contents sidebar Overview of Python Packaging The Packaging Flow Tutorials Toggle navigation of Tutorials Installing Packages Managing Application Dependencies Packaging Python Projects Guides Toggle navigation of Guides Installation Toggle navigation of Installation Install packages in a virtual environment using pip and venv Installing packages using virtualenv Installing stand alone command line tools Installing pip/setuptools/wheel with Linux Package Managers Installing scientific packages Building and Publishing Toggle navigation of Building and Publishing Writing your pyproject.toml Packaging and distributing projects Single-sourcing the package version Dropping support for older Python versions Packaging binary extensions Packaging namespace packages Creating and discovering plugins Using TestPyPI Making a PyPI-friendly README Publishing package distribution releases using GitHub Actions CI/CD workflows How to modernize a setup.py based project? Hosting Toggle navigation of Hosting Package index mirrors and caches Hosting your own simple repository Tool recommendations Analyzing PyPI package downloads Discussions Toggle navigation of Discussions Versioning Deploying Python applications pip vs easy_install install_requires vs requirements files Distribution package vs. import package Package Formats src layout vs flat layout Is setup.py deprecated? PyPA specifications Toggle navigation of PyPA specifications Package Distribution Metadata Toggle navigation of Package Distribution Metadata Names and normalization Core metadata specifications Version specifiers Dependency specifiers pyproject.toml specification Inline script metadata Platform compatibility tags Package Installation Metadata Toggle navigation of Package Installation Metadata Recording installed projects Entry points specification Recording the Direct URL Origin of installed distributions Direct URL Data Structure Python Virtual Environments Externally Managed Environments Package Distribution File Formats Toggle navigation of Package Distribution File Formats Source distribution format Binary distribution format Package Index Interfaces Toggle navigation of Package Index Interfaces The .pypirc file Simple repository API Project Summaries Glossary How to Get Support Contribute to this guide NewsEdit this page Toggle Light / Dark / Auto color theme Toggle table of contents sidebar # Welcome to the , a collection of tutorials and references to help you distribute and install Python packages with modern tools. This guide is maintained on GitHub by the Python Packaging Authority . We happily accept contributions and feedback . ? Overview and Flow # Note Building your understanding of Python packaging is a journey. Patience and continuous improvement are key to success. The overview and flow sections provide a starting point for understanding the Python packaging ecosystem. The Overview of Python Packaging explains Python packaging and its use when preparing and distributing projects. This section helps you build understanding about selecting the tools and processes that are most suitable for your use case. It includes what packaging is, the problems that it solves, and key considerations. To get an overview of the workflow used to publish your code, see packaging flow . Tutorials # Tutorials walk through the steps needed to complete a project for the first time. Tutorials aim to help you succeed and provide a starting point for future exploration. The Tutorials section includes: A tutorial on installing packages A tutorial on managing application dependencies in a version controlled project A tutorial on packaging and distributing your project Guides # Guides provide steps to perform a specific task. Guides are more focused on users who are already familiar with Python packaging and are looking for specific information. The Guides section provides how to” instructions in three major areas: package installation; building and distributing packages; miscellaneous topics. Explanations and Discussions # The Discussions section for in-depth explanations and discussion about topics, such as: Deploying Python applications pip vs easy_install Reference # The PyPA specifications section for packaging interoperability specifications. The list of other projects maintained by members of the Python Packaging Authority. The Glossary for definitions of terms used in Python packaging. Next Overview of Python Packaging Copyright © 2013–2020, PyPA Made with Sphinx and @pradyunsg ’s Furo Last updated on May 09, 2024 On this page Overview and Flow Tutorials Guides Explanations and Discussions...