jnplonte/python-api

python api boilerplate

PYTHON API

Version

v1.0.0

Dependencies

• python https://www.python.org/
• flask: https://flask-restful.readthedocs.io/en/latest/
• mongodb: https://www.mongodb.com/
• docker: https://www.docker.com/

Demo

• api: http://pythonapi.jnpl.me/
• api documentation: http://pythonapi.jnpl.me/documentation/

PYTHON

Installation

• create virtualenv virtualenv -p python python-env
• work on virtualenv source python-env/bin/activate
• install python dependencies by running pip install -r requirements.txt
• Generate documentation by running apidoc -i ./app/ -o ./documentation/ -f .py
• Install database mock data by running python seeders/seed_<seed-name>.py

How to Use

• run uwsgi app.ini it will listen to http://localhost:8383 with authorization Header

Testing

• run python -m unittest tests/test_<test-name>.py

DOCKER

Installation

• build docker-compose build
• install pip docker exec -ti pythonapi pip install -r requirements.txt
• seed data docker exec -ti pythonapi python seeders/seed_<seed-name>.py

How to Use

• run docker-compose up
• run docker-compose start

Testing

• run docker exec -ti pythonapi python -m unittest tests/test_<test-name>.py