Boilerplate flask configuration to create REST based web service projects.
It supports OAuth 2.0 authentification (only through the 'Password' authentication scheme for now). It also supports [conditional requests] (http://fideloper.com/api-etag-conditional-get), and provides concurrency control management through the use of entity tags.
- Flask
- Restless
- Flask Script
- Flask Migrate
- SQLAlchemy
- Flask SQLAlchemy
- Flask OAuthLib
For all requirements see the file requirements.txt
- Clone the repo
$ git clone https://github.com/niclabs/flask-rest-boilerplate.git
- Initialize the virtual environment (python 2.7+ and 3.4+ supported)
$ virtualenv venv --distribute --no-site-packages
$ source venv/bin/activate
- Download required packages
(venv)$ pip install -r requirements.txt
- Run the server
(venv)$ python manage.py runserver
The server should now be running on localhost:5000