alex/cookiecutter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add the MIT license by default.

Browse source
This commit is contained in:
Laurent LAPORTE 2018-10-06 22:00:08 +02:00
parent aeeca1565c
commit e3d6d72425
3 changed files with 37 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -10,9 +10,9 @@ Usage
git clone https://github.com/kragniz/cookiecutter-pypackage-minimal.git
cookiecutter cookiecutter-pypackage-minimal/
You should then change the classifiers in `{{ package_name }}/setup.py` - 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.python.org/pypi?:action=list_classifiers).
You should then change the classifiers in `{{ package_name }}/setup.py` - 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 - add a license to the project.
Fill out the README, and - if necessary - [choose a license](https://choosealicense.com/) for the project.
Explanation
-----------
@ -26,6 +26,18 @@ The decisions `cookiecutter-pypackage-minimal` makes should all be explained her
* **As few README files as possible**
Additional README files (AUTHORS, CHANGELOG, etc) should be left to the user to create when necessary.
### LICENSE
* **LICENSE can use reStructuredText format**
The provided license file use reStructuredText format. Of course you can decide to use a text format or even [Markdown](https://en.wikipedia.org/wiki/Markdown). It's up to you to choose the format which best satisfies your needs.
* **MIT license by default**
This template provides you the classic [MIT](https://choosealicense.com/licenses/mit/) licence: it lets people do almost anything they want with your project, including to make and distribute closed source versions.
If you [choose another license](https://choosealicense.com/), you also need to update the `{{ package_name }}/setup.py` file:
adjust the `classifiers` and `license` fields accordingly.
* **A license is a requirement**
Nowadays, people who want to use your library/application want to make sure they can do it legally.
If your library is a private library, you can use a private license. In the `{{ package_name }}/setup.py` file, set `license="Proprietary"`, and choose `'License :: Other/Proprietary License'` in the trove classifiers.
### `setup.py`
* **Use setuptools**