Skip to main content

Creates the skeleton of your Python project.

Project description

If you are like me, starting a new Python project from the scratch can be boring: create a, documentation, installation instructions, forget a file or two in the manifest, etc. This all is a time-consuming and error prone work, which gives no intellectual satisfaction. Yet, this is necessary to make your project a good citizen in the open source community.

Boilerplate produces beautiful skeletons for your Python projects so you can get up and running fast. It is influenced by this blog post:, although we do not follow these recommendations by the letter.

The filesystem structure

The boilerplate start <project> command will create the following tree under the current directory:

|- .gitignore
|- INSTALL.rst
|- README.rst
|- requirements.txt
|- requirements-dev.txt
|- docs/
|   |-
|   |- index.rst
|   |- make.bat
|   |- Makefile
|   |- _static/*
|   \- _templates/*
\- src/
    \- <project>
        |- <project>.py
        \- test/
            \- test_<project>.py



README.rst and INSTALL.rst





Project details

Download files

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

Files for pyboilerplate, version 0.2.1
Filename, size File type Python version Upload date Hashes
Filename, size pyboilerplate-0.2.1.tar.gz (18.1 kB) File type Source Python version None Upload date Hashes View

Supported by

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