Welcome to The Hitchhiker’s Guide to Packaging

Warning

This document is currently under development. Thank you for your interest.

Table of Contents

• Quick Start
  • 1. Lay out your project
  • 2. Describe your project
  • 3. Create your first release
  • 4. Register your package with the Python Package Index (PyPI)
  • 5. Upload your release, then grab your towel and save the Universe!
• Introduction to Packaging
  • The Packaging Ecosystem
  • Benefits of packaging
  • Current State of Packaging
  • Creating a Micro-Ecosystem with virtualenv
• Installing the Package Tools
  • Distribute
  • Pip Installs Python (Pip)
• Using Packages
  • Finding Packages
  • Installing from other sources
  • Running your own package index
• Creating a Package
  • Basics: Creating and Distributing Distributions
  • Packaging for a Particular Operating System (OS)
• Contribute Your Package to the World
  • The Python Package Index (PyPI)
  • Private and secondary PyPI servers
• Virtual Environments
  • Getting Started
• Specifications
  • Naming Specification
  • Versioning Specification
• Advanced Topics
• Future of Packaging
  • Inshort...
• Glossary
  • Citations
• Credits
  • Contributors
  • Referenced Materials
• License

Indices and tables

• Index
• Module Index
• Search Page