Repository files navigation

http://packaging.python.org

The "Python Packaging User Guide" (PyPUG) aims to be the authoritative resource onhow to package and install distributions in Python using current tools.

To follow the development of Python packaging, see thePythonPackaging Authority.

Everyone interacting in the Python Packaging User Guide project's codebases,issue trackers, chat rooms, and mailing lists is expected to follow thePyPA 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 inPython packaging.

In order to build this guide locally, you'll need:

1. Nox. You can install or upgradenox usingpip:

   pip install --upgrade nox-automation

2. Python 3.6. Our build scripts are designed to work with Python 3.6 only.See theHitchhiker's Guide to Python installation instructionsto install Python 3.6 on your operating system.

To build the guide run below bash command in the source folder:

nox -s build

After the process 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 broswer,bu it's recommendation to serve the guide using an http server.

You can build the guide and serve it via an HTTP server using the followingcommand:

nox -s preview

The guide will be browsable viahttp://localhost:8000.

The Python Packaging User Guide is licensed under a Creative CommonsAttribution-ShareAlike license:http://creativecommons.org/licenses/by-sa/3.0 .