This project is a skeleton of a Flask-restplus API. It tends to be modular in order to add plugins for larger projects (databases, sessions, async requests...)
Note : The installation into a virtualenv is heavily recommended.
If you want to install the package :
pip install .
For development purposes, you can install the package in editable mode with the dev requirements.
pip install -e . -r requirements-dev.txt
To start the application, you can use the file run.py :
python run.py
Then, you can access to the api in localhost :
curl -X GET -H "Content-Type: application/json" localhost:5000/api/hello/test
To use it in a Docker container, just build it :
docker build -t skeleton_api .
Then run it :
docker run -p 127.0.0.1:5000:80 skeleton_api
You can check the syntax using flake8 (you must have flake8 package installed first) :
flake8 api
You can also use tox (you must have tox package installed first) :
tox -e lint
To execute the test coverage, you must install the package with the dev requirements (see installation section).
Then, you can run the coverage with the following command :
coverage run --source api -m py.test
You can also use tox (you must have tox package installed first) :
tox -e test