What it says on the tin. Should be compatible with both Pythons 2 and 3.
You'll need an active virtualenv, cookiecutter, and GNU make
# In a virtualenv
cookiecutter https://github.com/afreeorange/template-python-flask-api.git
Then answer some questions, get into the project folder and type make
to see a list of project tasks.
- A basic
setuptools
configuration to package the project - Documentation using either Markdown/MkDocs or reStructuredText/Sphinx with a server and live-reloader for easy edits and changes
- Tests using
py.test
- Test coverage analysis using
coverage.py
- Linting using Flake8
- Easy version-bumping using
semantic versioning
and bumpversion - A comprehensive
.gitignore
(via Github) - A
Makefile
that allows me to do many other things :)
Do whatever you want.