https://github.com/stac-utils/titiler-pgstac
TiTiler + PgSTAC
https://github.com/stac-utils/titiler-pgstac
Last synced: 4 days ago
JSON representation
TiTiler + PgSTAC
- Host: GitHub
- URL: https://github.com/stac-utils/titiler-pgstac
- Owner: stac-utils
- License: mit
- Created: 2021-07-20T15:19:21.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-03T21:18:28.000Z (3 months ago)
- Last Synced: 2025-05-05T02:06:41.201Z (about 2 months ago)
- Language: Python
- Homepage: https://stac-utils.github.io/titiler-pgstac/
- Size: 22.9 MB
- Stars: 93
- Watchers: 9
- Forks: 31
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-earthobservation-code - titiler-pgstac - TiTiler + PgSTAC (`Python` processing of optical imagery (non deep learning) / Cloud Native Geospatial)
README
Connect PgSTAC and TiTiler.
---
**Documentation**: https://stac-utils.github.io/titiler-pgstac/
**Source Code**: https://github.com/stac-utils/titiler-pgstac
---
**TiTiler-PgSTAC** is a [TiTiler](https://github.com/developmentseed/titiler) extension that connects to a [PgSTAC](https://github.com/stac-utils/pgstac) database to create dynamic **mosaics** based on [search queries](https://github.com/radiantearth/stac-api-spec/tree/master/item-search).
## Installation
To install from PyPI and run:
```bash
# Make sure to have pip up to date
$ python -m pip install -U pip
# Install `psycopg` or `psycopg["binary"]` or `psycopg["c"]`
$ python -m pip install psycopg["binary"]
$ python -m pip install titiler.pgstac
```
To install from sources and run for development:
```
$ git clone https://github.com/stac-utils/titiler-pgstac.git
$ cd titiler-pgstac
$ python -m pip install -e .
```
### `PgSTAC` version
`titiler.pgstac` depends on `pgstac >=0.3.4` (https://github.com/stac-utils/pgstac/blob/main/CHANGELOG.md#v034).
### `psycopg` requirement
`titiler.pgstac` depends on the `psycopg` library. Because there are three ways of installing this package (`psycopg` or , `psycopg["c"]`, `psycopg["binary"]`), the user must install this separately from `titiler.pgstac`.
- `psycopg`: no wheel, pure python implementation. It requires the `libpq` installed in the system.
- `psycopg["binary"]`: binary wheel distribution (shipped with libpq) of the `psycopg` package and is simpler for development. It requires development packages installed on the client machine.
- `psycopg["c"]`: a C (faster) implementation of the libpq wrapper. It requires the `libpq` installed in the system.
`psycopg[c]` or `psycopg` are generally recommended for production use.
In `titiler.pgstac` setup.py, we have added three options to let users choose which psycopg install to use:
- `python -m pip install titiler.pgstac["psycopg"]`: pure python
- `python -m pip install titiler.pgstac["psycopg-c"]`: use the C wrapper (requires development packages installed on the client machine)
- `python -m pip install titiler.pgstac["psycopg-binary"]`: binary wheels
## Launch
You'll need to have `POSTGRES_USER`, `POSTGRES_PASS`, `POSTGRES_DBNAME`, `POSTGRES_HOST`, `POSTGRES_PORT` variables set in your environment pointing to your Postgres database where pgstac has been installed.
```
export POSTGRES_USER=username
export POSTGRES_PASS=password
export POSTGRES_DBNAME=postgis
export POSTGRES_HOST=database
export POSTGRES_PORT=5432
```
```
$ python -m pip install uvicorn
$ uvicorn titiler.pgstac.main:app --reload
```
### Using Docker
```
$ git clone https://github.com/stac-utils/titiler-pgstac.git
$ cd titiler-pgstac
$ docker compose up --build tiler
# or
$ docker compose up --build tiler-uvicorn
```
## Contribution & Development
See [CONTRIBUTING.md](https://github.com//stac-utils/titiler-pgstac/blob/main/CONTRIBUTING.md)
## License
See [LICENSE](https://github.com//stac-utils/titiler-pgstac/blob/main/LICENSE)
## Authors
See [contributors](https://github.com/stac-utils/titiler-pgstac/graphs/contributors) for a listing of individual contributors.
## Changes
See [CHANGES.md](https://github.com/stac-utils/titiler-pgstac/blob/main/CHANGES.md).