https://github.com/developmentseed/tipg
Simple and Fast Geospatial OGC Features and Tiles API for PostGIS.
https://github.com/developmentseed/tipg
Last synced: 10 months ago
JSON representation
Simple and Fast Geospatial OGC Features and Tiles API for PostGIS.
- Host: GitHub
- URL: https://github.com/developmentseed/tipg
- Owner: developmentseed
- License: mit
- Created: 2022-10-05T16:03:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-06T07:44:07.000Z (12 months ago)
- Last Synced: 2025-06-07T07:17:50.722Z (11 months ago)
- Language: PLpgSQL
- Homepage: https://developmentseed.org/tipg/
- Size: 14.6 MB
- Stars: 174
- Watchers: 9
- Forks: 26
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Simple and Fast Geospatial OGC Features and Tiles API for PostGIS.
---
**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](https://ogcapi.ogc.org/features) and [OGC Tiles](https://ogcapi.ogc.org/tiles/) specifications.
> **Note**
> This project is the result of the merge between [tifeatures](https://github.com/developmentseed/tifeatures) and [timvt](https://github.com/developmentseed/timvt).
## Install
```bash
$ 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.
```sql
SELECT name, default_version,installed_version
FROM pg_available_extensions WHERE name LIKE 'postgis%' or name LIKE 'address%';
```
```sql
CREATE EXTENSION postgis;
```
### Configuration
To be able to work, the application will need access to the database. `tipg` uses [Starlette](https://www.starlette.io/config/)'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](https://github.com/developmentseed/tipg/blob/main/.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
```bash
$ python -m 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 |
| -- | -- |
main commit | `ghcr.io/developmentseed/tipg:latest`
tags | `ghcr.io/developmentseed/tipg:X.X.X`
dockerfile | [/dockerfiles/Dockerfile](https://github.com/developmentseed/tipg/blob/main/dockerfiles/Dockerfile)
See all version at https://github.com/developmentseed/tipg/pkgs/container/tipg
```
$ docker run \
-p 8000:8000 \
-e DATABASE_URL=postgresql://username:password@0.0.0.0:5432/postgis \
ghcr.io/developmentseed/tipg:latest \
uvicorn tipg.main:app --host 0.0.0.0 --port 8000 --workers 1
# using Gunicorn
$ docker run \
-p 8000:8000 \
-e DATABASE_URL=postgresql://username:password@0.0.0.0:5432/postgis \
ghcr.io/developmentseed/tipg:latest \
gunicorn -k uvicorn.workers.UvicornWorker tipg.main:app --bind 0.0.0.0:8000 --workers 1
```
## Contribution & Development
See [CONTRIBUTING.md](https://github.com/developmentseed/tipg/blob/main/CONTRIBUTING.md)
## License
See [LICENSE](https://github.com/developmentseed/tipg/blob/main/LICENSE)
## Authors
Created by [Development Seed]()
## Changes
See [CHANGES.md](https://github.com/developmentseed/tipg/blob/main/CHANGES.md).