If you are like me, starting a new Python project from the scratch can be boring: create a setup.py, 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: http://jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/, 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
|- LICENSE
|- MANIFEST.in
|- INSTALL.rst
|- README.rst
|- VERSION
|- requirements.txt
|- requirements-dev.txt
|- setup.py
|- docs/
| |- conf.py
| |- index.rst
| |- make.bat
| |- Makefile
| |- _static/*
| \- _templates/*
\- src/
\- <project>
|- __init__.py
|- __meta__.py
|- <project>.py
\- test/
|- __init__.py
\- test_<project>.py
setup.py
src/*
docs/*
README.rst and INSTALL.rst
VERSION
requirements.txt
MANIFEST.in
LICENSE
.gitignore
1 maintainer
Metadata
1 maintainer
Release files for pyboilerplate 0.2.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| pyboilerplate-0.2.1.tar.gz | 18.1 kB | Without provenance | Details |
Release files / pyboilerplate-0.2.1.tar.gz
| Download URL | pyboilerplate-0.2.1.tar.gz |
|---|---|
| Size | 18.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c067cb561aa6a86c483f0b5f00a5321b7746e805b4bde7a91af509840e5323f6
|
|
BLAKE2b-256 checksum How to use checksums |
baf4e456f95ca9d7fdbf139b651fff0c9315b75af4f31395223c53559a1b2f90
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for pyboilerplate 0.2.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
