Skip to content

afreeorange/template-python-flask-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Cookiecutter Template for a Flask-based Web Service

What it says on the tin. Should be compatible with both Pythons 2 and 3.

Usage

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.

What that does

  • 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 :)

License

Do whatever you want.

About

🍪 Cookiecutter-based template for a REST API built using Flask

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published