44 lines
1.5 KiB
Markdown
44 lines
1.5 KiB
Markdown
cookiecutter-pypackage-minimal
|
|
==============================
|
|
|
|
An opinionated, minimal [cookiecutter](https://github.com/audreyr/cookiecutter)
|
|
template for Python packages, and some guidelines for Python packaging.
|
|
|
|
Usage
|
|
-----
|
|
|
|
pip install cookiecutter
|
|
git clone https://github.com/kragniz/cookiecutter-pypackage-minimal.git
|
|
cookiecutter cookiecutter-pypackage-minimal/
|
|
|
|
You should then change the classifiers in `{{ package_name }}/pyproject.toml` -
|
|
it is assumed that the project will run on the latest versions of Python 2 and
|
|
3, so you should remove any classifiers that do not apply. The full list of PyPI
|
|
classifiers can be found [here](https://pypi.org/classifiers/).
|
|
|
|
Fill out the README, and - if necessary - [choose a
|
|
license](https://choosealicense.com/) for the project.
|
|
|
|
Explanation
|
|
-----------
|
|
|
|
The decisions `cookiecutter-pypackage-minimal` makes should all be explained here.
|
|
|
|
### README
|
|
|
|
* **README should use reStructuredText format**
|
|
This is the format used by most Python tools, is expected by
|
|
[setuptools](https://setuptools.readthedocs.io), and can be used by
|
|
[Sphinx](http://sphinx-doc.org/).
|
|
* **As few README files as possible**
|
|
Additional README files (AUTHORS, CHANGELOG, etc) should be left to the user
|
|
to create when necessary.
|
|
|
|
### LICENSE
|
|
|
|
* **GPLv3 license by default**
|
|
This template provides you the GPLv3 licence.
|
|
You can [choose another license](https://choosealicense.com/).
|
|
* **A license is a requirement**
|
|
Nowadays, people who want to use your library/application want to make sure
|
|
they can do it legally.
|