An open API service indexing awesome lists of open source software.

https://github.com/dvrpc/traffic-counts-api

Traffic Counts API
https://github.com/dvrpc/traffic-counts-api

Last synced: 5 months ago
JSON representation

Traffic Counts API

Awesome Lists containing this project

README

          

# Traffic Counts API

API for DVRPC's traffic counts database, which is hosted on Oracle's cloud server and configured to allow connections from allow-listed IP addresses only.

The following configuration variables should go in a git-ignored config.py file at the root level:
* USER (database user)
* PASSWORD (database password)
* DB (database)
* URL_ROOT (path preceding individual endpoints)

An example is provided at config.py.example.

See full documentation of the API at and .

## Development

A server on Digital Ocean (oracle-dev) has been added to the allow-list for development purposes. Use the requirements_dev.txt file to create a Python virtual environment, and then run `fastapi dev` from the activated virtual environment to start a development server. Use ssh tunneling to reach endpoints locally (e.g. `ssh -L 8000:127.0.0.1:8000 [host]` to access in your browser).

## Production

Managed by [cloud-ansible project](https://github.com/dvrpc/cloud-ansible).