Skip to content

Latest commit

 

History

History
160 lines (114 loc) · 6.63 KB

README.md

File metadata and controls

160 lines (114 loc) · 6.63 KB
Raw

Simple and Fast Geospatial OGC Features and Tiles API for PostGIS.

Test Coverage Package version License

Documentation: https://developmentseed.org/tipg/

Source Code: https://github.com/developmentseed/tipg

tipg, pronounced T[ee]pg, is a Python package that helps create lightweight OGC Features and Tiles API with a PostGIS Database backend. The API has been designed for OGC Features and OGC Tiles specifications.

Note This project is the result of the merge between tifeatures and timvt.

Install

$ python -m pip install pip -U
$ python -m pip install tipg

# or from source
$ git clone https://github.com/developmentseed/tipg.git
$ cd tipg
$ python -m pip install -e .

OGC Specifications

Specification Status link
OGC Common Part 1: Core ✅ https://docs.ogc.org/DRAFTS/19-072.html
OGC Common Part 2: Geospatial Data ✅ http://docs.ogc.org/DRAFTS/20-024.html
OGC Features Part 1: Core ✅ https://docs.ogc.org/is/17-069r4/17-069r4.html
OGC Features Part 2: CRS by Reference ❌ https://docs.ogc.org/is/18-058r1/18-058r1.html
OGC Features Part 3: Filtering / CQL2 ✅ https://docs.ogc.org/DRAFTS/19-079r1.html
OGC Tiles Part 1: Core ✅ https://docs.ogc.org/is/20-057/20-057.html

Notes:

We chose to avoid implementing the second part of the specification to prevent the introduction of CRS-based GeoJSON. We may review this decision in the future.

While we tried to follow OGC specifications to the letter, some API endpoints might have more capabilities (e.g., geometry column selection).

PostGIS/PostgreSQL

tipg relies greatly on PostGIS' ST_* functions. PostGIS must be installed on your PostgreSQL database.

SELECT name, default_version,installed_version
FROM pg_available_extensions WHERE name LIKE 'postgis%' or name LIKE 'address%';
CREATE EXTENSION postgis;

Configuration

To be able to work, the application will need access to the database. tipg uses Starlette's configuration pattern, which makes use of environment variables or a .env file to pass variables to the application.

An example of a .env file can be found in .env.example

# you need to define the DATABASE_URL directly
DATABASE_URL=postgresql://username:password@0.0.0.0:5432/postgis

More info about configuration options at https://developmentseed.org/tipg/user_guide/configuration/

Launch

$ pip install uvicorn

# Set your PostGIS database instance URL in the environment
$ export DATABASE_URL=postgresql://username:password@0.0.0.0:5432/postgis
$ uvicorn tipg.main:app

# or using Docker

$ docker-compose up app

Docker images

We are publishing two different docker images on tag and on every commit to main branch:

Gunicorn Uvicorn
main commit ghcr.io/developmentseed/tipg:latest ghcr.io/developmentseed/tipg:uvicorn-latest
tags ghcr.io/developmentseed/tipg:0.0.0 ghcr.io/developmentseed/tipg:uvicorn-0.0.0
dockerfile /dockerfiles/Dockerfile.gunicorn /dockerfiles/Dockerfile.uvicorn

See all version at https://github.com/developmentseed/tipg/pkgs/container/tipg

# Gunicorn image
$ docker run \
    -p 8081:8081 \
    -e PORT=8081 \
    -e DATABASE_URL=postgresql://username:password@0.0.0.0:5432/postgis \
    ghcr.io/developmentseed/tipg:latest

# or Uvicorn image
$ docker run \
    -p 8081:8081 \
    -e PORT=8081 \
    -e DATABASE_URL=postgresql://username:password@0.0.0.0:5432/postgis \
    ghcr.io/developmentseed/tipg:uvicorn-latest

Note: If you are planning to use the docker image in a kubernetes deployment you may want to use the uvicorn image (ref: https://fastapi.tiangolo.com/deployment/server-workers/).

Contribution & Development

See CONTRIBUTING.md

License

See LICENSE

Authors

Created by Development Seed

Changes

See CHANGES.md.