https://github.com/dvrpc/link-api
https://github.com/dvrpc/link-api
api
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dvrpc/link-api
- Owner: dvrpc
- License: gpl-3.0
- Created: 2023-08-22T13:35:31.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-11-13T16:42:17.000Z (7 months ago)
- Last Synced: 2025-11-13T18:24:25.496Z (7 months ago)
- Topics: api
- Language: Python
- Size: 112 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# link-api
## Overview
This is an API for the [Link](https://github.com/dvrpc/link) react app.
Most of the calls use SQLAlchemy models and schemas to access a Postgres DB, but the /analyze endpoint uses
the LTS Connectivity tool (linked below).
It uses:
* FastAPI
* Postgres (with PostGIS and PGrouting)
* DVRPC's [LTS/sidewalk connectivity tool.](https://github.com/dvrpc/LTS_island_connectivity)
* ogr2ogr
## Setup/Installation
#### 1. Install dependencies, if not installed. For postgres with extensions, consider using
```shell
sudo apt install postgresql-16-pgrouting
```
which will install PostgreSQL, PostGIS, and PGrouting. If you have postgres already, you need to install the other two individually. Setup any roles you want.
You also need ogr2ogr. For Linux:
```shell
sudo apt install gdal-bin
```
#### 2. Create an empty virtual environment
```shell
python -m venv ve
```
Then activate the environment.
```shell
. ve/bin/activate
```
#### 3. Install the requirements with:
```shell
pip install wheel && pip install -r requirements_base.txt
```
#### 4. Add a .env file
Create a .env file at the root of the project. An example is below, which contains a URI to a database.
```
DB_URI=postgresql://user:pw@host:port/db
```
You may also alter the path by including a URL_ROOT variable (that starts with a `/`). If not included, it will not be used.
```
DB_URI=postgresql://user:pw@host:port/db
URL_ROOT=/api
```
#### 5. Add config file for pg-data-etl
You'll need to add a configuration file for pg-data-etl at the root of this project.
It must be named 'database_connections.cfg', and should be formatted like this:
```
[localhost]
host = host
un = postgres
pw = password
port = port
db_name = db_name
```
Don't edit the localhost in brackets, as the script searches for it (see analyze endpoint)
but change all the other variables.
#### 6. Import database backup
If you're putting this onto a remote server, you need to pipe a copy of the database from a machine that's behind the DVRPC firewall, as all of the data import and setup scripts can only be run behind the firewall, pulling from DVRPC's GIS postgres server.
The most recent backup can be found in 'G:\Shared drives\Bike LTS and Connectivity Analysis Webmap\Rethinking Connectivity\DB_Backups'.
Pipe a copy in with:
```shell
psql -U your_username -h your_host -p your_port -d target_database < backup.sql
```
## Usage
Start the development server with
```shell
cd app
uvicorn main:app --reload
```
See what API calls are supported by visiting [localhost:8000/docs](localhost:8000/docs). (Note that if you set `URL_ROOT`, this would be different, e.g. a `URL_ROOT` of `/api ` would result in [localhost:8000/api/docs](localhost:8000/api/docs)).
## License
The project uses the GPL 3.0 license.