Python 3 Flask RESTful API template

Contents of this document

• Description
• Requirements
• Installation
• Usage
• Tests

Description

This is a template project for creating REST APIs using Python 3 and Flask.

Requirements

See requirements.txt.

Installation

Run the install.sh script to install the app's dependencies (assumes activated Python3 virtual env):

./install.sh

Usage

Run the following commands start the server (assumes activated Python3 virtual env):

python app.py

Tests

Run the install-dev-dependencies.sh script to install the app's dev/tests dependencies (assumes activated Python3 virtual env):

sudo ./install-dev-dependencies.sh
pip install -r dev-requirements.txt

Run the following command to run smoke tests (server must be running):

newman run tests/smoke-tests.json -e tests/local-environment.json