<p align="center">
<img width="500" src="https://github.com/stac-utils/titiler-pgstac/assets/10407788/24a64ea9-fede-4ee8-ab8d-625c9e94db44"/>
<p align="center">Connect PgSTAC and TiTiler.</p>
</p>
<p align="center">
<a href="https://github.com/stac-utils/titiler-pgstac/actions?query=workflow%3ACI" target="_blank">
<img src="https://github.com/stac-utils/titiler-pgstac/workflows/CI/badge.svg" alt="Test">
</a>
<a href="https://codecov.io/gh/stac-utils/titiler-pgstac" target="_blank">
<img src="https://codecov.io/gh/stac-utils/titiler-pgstac/branch/main/graph/badge.svg" alt="Coverage">
</a>
<a href="https://pypi.org/project/titiler.pgstac" target="_blank">
<img src="https://img.shields.io/pypi/v/titiler.pgstac?color=%2334D058&label=pypi%20package" alt="Package version">
</a>
<a href="https://github.com/stac-utils/titiler-pgstac/blob/main/LICENSE" target="_blank">
<img src="https://img.shields.io/github/license/stac-utils/titiler-pgstac.svg" alt="License">
</a>
</p>
---
**Documentation**: <a href="https://stac-utils.github.io/titiler-pgstac/" target="_blank">https://stac-utils.github.io/titiler-pgstac/</a>
**Source Code**: <a href="https://github.com/stac-utils/titiler-pgstac" target="_blank">https://github.com/stac-utils/titiler-pgstac</a>
---
**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:
- `pip install titiler.pgstac["psycopg"]`: pure python
- `pip install titiler.pgstac["psycopg-c"]`: use the C wrapper (requires development packages installed on the client machine)
- `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
```
```
$ 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
```
It runs `titiler.pgstac` using Gunicorn web server. To run Uvicorn based version:
```
$ 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).
Raw data
{
"_id": null,
"home_page": null,
"name": "titiler.pgstac",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "COG, STAC, MosaicJSON, Fastapi, Dynamic tile server, pgSTAC",
"author": null,
"author_email": "Vincent Sarago <vincent@developmentseed.com>,David Bitner <david@developmentseed.com>",
"download_url": "https://files.pythonhosted.org/packages/e7/71/0ee0be8fa05c7b63371e636474a79b829eb7e81eb64418301c72bc2cd7c3/titiler.pgstac-1.4.0.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img width=\"500\" src=\"https://github.com/stac-utils/titiler-pgstac/assets/10407788/24a64ea9-fede-4ee8-ab8d-625c9e94db44\"/>\n <p align=\"center\">Connect PgSTAC and TiTiler.</p>\n</p>\n\n<p align=\"center\">\n <a href=\"https://github.com/stac-utils/titiler-pgstac/actions?query=workflow%3ACI\" target=\"_blank\">\n <img src=\"https://github.com/stac-utils/titiler-pgstac/workflows/CI/badge.svg\" alt=\"Test\">\n </a>\n <a href=\"https://codecov.io/gh/stac-utils/titiler-pgstac\" target=\"_blank\">\n <img src=\"https://codecov.io/gh/stac-utils/titiler-pgstac/branch/main/graph/badge.svg\" alt=\"Coverage\">\n </a>\n <a href=\"https://pypi.org/project/titiler.pgstac\" target=\"_blank\">\n <img src=\"https://img.shields.io/pypi/v/titiler.pgstac?color=%2334D058&label=pypi%20package\" alt=\"Package version\">\n </a>\n <a href=\"https://github.com/stac-utils/titiler-pgstac/blob/main/LICENSE\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/license/stac-utils/titiler-pgstac.svg\" alt=\"License\">\n </a>\n</p>\n\n---\n\n**Documentation**: <a href=\"https://stac-utils.github.io/titiler-pgstac/\" target=\"_blank\">https://stac-utils.github.io/titiler-pgstac/</a>\n\n**Source Code**: <a href=\"https://github.com/stac-utils/titiler-pgstac\" target=\"_blank\">https://github.com/stac-utils/titiler-pgstac</a>\n\n---\n\n**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).\n\n## Installation\n\nTo install from PyPI and run:\n\n```bash\n# Make sure to have pip up to date\n$ python -m pip install -U pip\n\n# Install `psycopg` or `psycopg[\"binary\"]` or `psycopg[\"c\"]`\n$ python -m pip install psycopg[\"binary\"]\n\n$ python -m pip install titiler.pgstac\n```\n\nTo install from sources and run for development:\n\n```\n$ git clone https://github.com/stac-utils/titiler-pgstac.git\n$ cd titiler-pgstac\n$ python -m pip install -e .\n```\n\n### `PgSTAC` version\n\n`titiler.pgstac` depends on `pgstac >=0.3.4` (https://github.com/stac-utils/pgstac/blob/main/CHANGELOG.md#v034).\n\n### `psycopg` requirement\n\n`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`.\n\n- `psycopg`: no wheel, pure python implementation. It requires the `libpq` installed in the system.\n- `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.\n- `psycopg[\"c\"]`: a C (faster) implementation of the libpq wrapper. It requires the `libpq` installed in the system.\n\n`psycopg[c]` or `psycopg` are generally recommended for production use.\n\nIn `titiler.pgstac` setup.py, we have added three options to let users choose which psycopg install to use:\n\n- `pip install titiler.pgstac[\"psycopg\"]`: pure python\n- `pip install titiler.pgstac[\"psycopg-c\"]`: use the C wrapper (requires development packages installed on the client machine)\n- `pip install titiler.pgstac[\"psycopg-binary\"]`: binary wheels\n\n## Launch\n\nYou'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.\n\n```\nexport POSTGRES_USER=username\nexport POSTGRES_PASS=password\nexport POSTGRES_DBNAME=postgis\nexport POSTGRES_HOST=database\nexport POSTGRES_PORT=5432\n```\n\n```\n$ pip install uvicorn\n$ uvicorn titiler.pgstac.main:app --reload\n```\n\n### Using Docker\n\n```\n$ git clone https://github.com/stac-utils/titiler-pgstac.git\n$ cd titiler-pgstac\n$ docker compose up --build tiler\n```\n\nIt runs `titiler.pgstac` using Gunicorn web server. To run Uvicorn based version:\n\n```\n$ docker compose up --build tiler-uvicorn\n```\n\n## Contribution & Development\n\nSee [CONTRIBUTING.md](https://github.com//stac-utils/titiler-pgstac/blob/main/CONTRIBUTING.md)\n\n## License\n\nSee [LICENSE](https://github.com//stac-utils/titiler-pgstac/blob/main/LICENSE)\n\n## Authors\n\nSee [contributors](https://github.com/stac-utils/titiler-pgstac/graphs/contributors) for a listing of individual contributors.\n\n## Changes\n\nSee [CHANGES.md](https://github.com/stac-utils/titiler-pgstac/blob/main/CHANGES.md).\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Connect PgSTAC and TiTiler.",
"version": "1.4.0",
"project_urls": {
"Changelog": "https://stac-utils.github.io/titiler-pgstac/release-notes/",
"Documentation": "https://stac-utils.github.io/titiler-pgstac/",
"Homepage": "https://stac-utils.github.io/titiler-pgstac/",
"Issues": "https://github.com/stac-utils/titiler-pgstac/issues",
"Source": "https://github.com/stac-utils/titiler-pgstac"
},
"split_keywords": [
"cog",
" stac",
" mosaicjson",
" fastapi",
" dynamic tile server",
" pgstac"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5518a5faa34b4b7517daff181687c561ceadab5884a95bfdd18dbb7638d2780e",
"md5": "febf0a92a19515148c8524574228ead7",
"sha256": "6459f55f5a5eb099e72308ace461ce4d87285af9692342d9cda7508963a7f2d9"
},
"downloads": -1,
"filename": "titiler.pgstac-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "febf0a92a19515148c8524574228ead7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 40326,
"upload_time": "2024-09-06T09:55:06",
"upload_time_iso_8601": "2024-09-06T09:55:06.647880Z",
"url": "https://files.pythonhosted.org/packages/55/18/a5faa34b4b7517daff181687c561ceadab5884a95bfdd18dbb7638d2780e/titiler.pgstac-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e7710ee0be8fa05c7b63371e636474a79b829eb7e81eb64418301c72bc2cd7c3",
"md5": "8aa4a18aee87dc520ffaa1489339b2d7",
"sha256": "fbfb9f73a015fcbac29517e9855371eb7ccf69cf7af3c9eed183fd31c7c3b3ca"
},
"downloads": -1,
"filename": "titiler.pgstac-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "8aa4a18aee87dc520ffaa1489339b2d7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 35986,
"upload_time": "2024-09-06T09:55:08",
"upload_time_iso_8601": "2024-09-06T09:55:08.194959Z",
"url": "https://files.pythonhosted.org/packages/e7/71/0ee0be8fa05c7b63371e636474a79b829eb7e81eb64418301c72bc2cd7c3/titiler.pgstac-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-06 09:55:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "stac-utils",
"github_project": "titiler-pgstac",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "titiler.pgstac"
}
JSON
