README.md

Route Link API

An API for accessing data contained in the Priority Route Link Details dataset.

Built as an example of REST, SQL, PANDAS and FLASK usage.

Installation

# how to setup a virtual environment
python -m venv env
env\Scripts\activate

git clone https://github.com/ChristopherAyling/RouteLinkAPI.git
cd RouteLinkAPI
pip install -r requirements.txt

Running

Development

python app.py

Production

python app.py --prod

Usage

All returns are JSON formatted.

GET /routes

GET /routes/<int>

GET /search?query=<string>