The "Python Packaging User Guide" (PyPUG) aims to be the authoritative resource on how to package and install distributions in Python using current tools.
To follow the development of Python packaging, see the Python Packaging Authority.
Everyone interacting in the Python Packaging User Guide project's codebases, issue trackers, chat rooms, and mailing lists are expected to follow the PyPA Code of Conduct.
This Guide was forked from the “Hitchhiker's Guide to Packaging” in March 2013, which was maintained by Tarek Ziadé. Thank you Tarek for all your efforts in Python packaging.
In order to build this guide locally, you'll need:
Nox. You can install or upgrade nox using
pip:pip install --upgrade nox-automation
Python 3.6. Our build scripts are designed to work with Python 3.6 only. See the Hitchhiker's Guide to Python installation instructions to install Python 3.6 on your operating system.
To build the guide, run the following bash command in the source folder:
nox -s build
After the process has completed you can find the HTML output in the
./build/html directory. You can open the index.html file to view the
guide in web browser, but it's recommended to serve the guide using an HTTP
server.
You can build the guide and serve it via an HTTP server using the following command:
nox -s preview
The guide will be browsable via http://localhost:8000.
The Python Packaging User Guide is licensed under a Creative Commons Attribution-ShareAlike license: http://creativecommons.org/licenses/by-sa/3.0 .