Skip to main content

A small example package

Project description

================================ python-package-template (pypack)

Provides a command to easily create a standard Python package layout (i.e. README, package directory, etc.), following the Hitchhiker's Guide to Packaging_.

.. _Hitchhiker's Guide to Packaging:


  • Creates a complete Python package template, ready for creating distribution files and uploading to the Python package index (PyPI)_.
  • Uses Distribute by default.
  • template, with inclusion of README and other standard files, as well as ignoring of dist/ directory that gets created when building the the package's distribution files.
  • No external dependencies, only relies on Python standard library.

.. _Python package index (PyPI):


#. Run pypack, specifying the name of your new package (optionally, use command line options to provide additional information, see pypack -h).

a) If you want to create a new Python package in an existing directory, just specify the desired Python package name::

      pypack mynewpackage

b) If you want to specify different directory, you may optionally use the -t (or --target) option to specify a target, non-existent directory::

      pypack mynewpackage -t /new/path

#. Review/edit the generated files #. Add your code, documentation, etc. #. Create distribution tarball::

   cd mynewpackage
   python sdist

#. Register project on PyPI::

   python register

#. Upload to PyPI::

   python sdist upload



  • Sphinx documentation layout, or at least an option to create a docs directory.
  • Support for a license file, allowing selection from a list of common open-source license templates
  • GitHub and Bitbucket compatibility for displaying readme file
  • git/hg ignore files
  • Allow use of config file to specify default options for author, license, etc.
  • An interactive option that prompts for needed info.

Similar Projects

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

universalQueue-0.0.2.tar.gz (2.4 kB view hashes)

Uploaded source

Built Distribution

universalQueue-0.0.2-py2-none-any.whl (3.6 kB view hashes)

Uploaded py2

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page