Awesome Open Source
Awesome Open Source

Flask REST Template

Code Health Build Status Coverage Status

About the project (some comments):

The ideia behind the project is to create an useful and simple template for an rest app . Besides the good intentions, I tried to follow some ideas that I've learned. (see "inspirations" item).

I also tried to create useful docstrings and helpers functions. However, I did not create (yet) a documentation based on docstring (e.g. using sphinx), what [IMO] could give an idea about write docs.

Instead to use the default (from stdlib) unittest module, I prefer to use pytest. I hope it can be useful and nice.

Python version

Python 3.4.x

The module users

This module is a complete CRUD as an example of structure to facilitate a demonstration about write tests (unit and integration). In this mock, I used passlib to generate hashs, but just as an example...

Flask extensions and other components

Main requirements

  • Flask-MongoEngine
  • Flask-JWT
  • Flask-Restful
  • uWSGI

Testing requirements

  • Pytest
  • pytest-cov
  • pylama

Alternative to MongoEngine + MongoDB

It's a possible issue/to-do. Create a branch using something like sqlalchemy + postgres...

How to collaborate

There is a lot of things to do:

  • Improving tests and coverage
  • Updating the use of third party libs
  • Improving this README.md
  • Reporting an issue (typo, RFC, other kind of mistake/error)
  • Adding a python2 support ( I did not verify it yet)
  • and etc

About the license:

It's a public domain project. =]

About the inspirations:

  • Ideas and answers >> #pocoo IRC channel;
  • cookiecutter-flask;
  • Flask Snippets;
  • Flask-restful-example;
  • What the Flask a tutorial in portuguese by Bruno Rocha
  • Flaskbook by Miguel Grinberg
  • Some questions in Stack Overflow or tweets that I don't have a link. =P

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
python (55,471
boilerplate (648
template (544
flask (540
rest (502
flask-application (36
public-domain (36