https://github.com/spotlightkid/cookiecutter-python-package
Basic Python package cookiecutter template without bloat
https://github.com/spotlightkid/cookiecutter-python-package
Last synced: 10 months ago
JSON representation
Basic Python package cookiecutter template without bloat
- Host: GitHub
- URL: https://github.com/spotlightkid/cookiecutter-python-package
- Owner: SpotlightKid
- Created: 2017-03-01T19:01:10.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-24T13:42:49.000Z (almost 9 years ago)
- Last Synced: 2025-01-25T12:41:53.558Z (12 months ago)
- Language: Python
- Size: 26.4 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
Awesome Lists containing this project
README
Python Package Cookiecutter Template
------------------------------------
You want to start a new Python project? Then please use this project template.
Install cookiecutter from PyPI (do not install it via your system package
manager, because the version you'll get will probably be too old). You need
at least cookiecutter version 1.4.0::
$ [sudo] pip install -U [--user] cookiecutter
Create the project structure::
$ cookiecutter gh:SpotlightKid/python-package-cookiecutter
Customize:
1. Adapt ``LICENSE.rst``.
2. Adapt ``setup.py`` (``license``, ``classifiers``, ``install_requires``).
3. Write tests.
4. Write app.
5. Run tests.
6. Edit ``README.rst`` and adapt quickstart instructions.
7. Release!
Have fun!
TODO
----
* Add pydocstyle configuration
* Add pylint configuration
* Check parameter definition in docstrings?