titiler-pgstac 1.2.3__tar.gz

titiler.pgstac-1.2.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Microsoft Corporation and other contributors.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

titiler.pgstac-1.2.3/PKG-INFO

@@ -0,0 +1,147 @@
+Metadata-Version: 2.1
+Name: titiler.pgstac
+Version: 1.2.3
+Summary: Connect PgSTAC and TiTiler.
+Keywords: COG,STAC,MosaicJSON,Fastapi,Dynamic tile server,pgSTAC
+Author-email: Vincent Sarago <vincent@developmentseed.com>,David Bitner <david@developmentseed.com>
+Requires-Python: >=3.8
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Topic :: Scientific/Engineering :: GIS
+Provides-Extra: dev
+Provides-Extra: psycopg
+Provides-Extra: psycopg-binary
+Provides-Extra: psycopg-c
+Provides-Extra: test
+Project-URL: Changelog, https://stac-utils.github.io/titiler-pgstac/release-notes/
+Project-URL: Documentation, https://stac-utils.github.io/titiler-pgstac/
+Project-URL: Homepage, https://stac-utils.github.io/titiler-pgstac/
+Project-URL: Issues, https://github.com/stac-utils/titiler-pgstac/issues
+Project-URL: Source, https://github.com/stac-utils/titiler-pgstac
+Description-Content-Type: text/markdown
+
+<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).
+

titiler.pgstac-1.2.3/README.md

@@ -0,0 +1,118 @@
+<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).

titiler.pgstac-1.2.3/pyproject.toml

@@ -0,0 +1,141 @@
+[project]
+name = "titiler.pgstac"
+description = "Connect PgSTAC and TiTiler."
+readme = "README.md"
+requires-python = ">=3.8"
+authors = [
+    { name = "Vincent Sarago", email = "vincent@developmentseed.com" },
+    { name = "David Bitner", email = "david@developmentseed.com" },
+]
+keywords = [
+    "COG",
+    "STAC",
+    "MosaicJSON",
+    "Fastapi",
+    "Dynamic tile server",
+    "pgSTAC",
+]
+classifiers = [
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: GIS",
+]
+dependencies = [
+    "titiler.core>=0.17.0,<0.18",
+    "titiler.mosaic>=0.17.0,<0.18",
+    "geojson-pydantic~=1.0",
+    "pydantic>=2.4,<3.0",
+    "pydantic-settings~=2.0",
+]
+dynamic = []
+version = "1.2.3"
+
+[project.license]
+file = "LICENSE"
+
+[project.optional-dependencies]
+psycopg = [
+    "psycopg[pool]",
+]
+psycopg-c = [
+    "psycopg[c,pool]",
+]
+psycopg-binary = [
+    "psycopg[binary,pool]",
+]
+dev = [
+    "pre-commit",
+]
+test = [
+    "pytest",
+    "pytest-cov",
+    "pytest-asyncio",
+    "httpx",
+    "pypgstac>=0.8,<0.9",
+    "psycopg2",
+    "pytest-pgsql",
+]
+
+[project.urls]
+Homepage = "https://stac-utils.github.io/titiler-pgstac/"
+Documentation = "https://stac-utils.github.io/titiler-pgstac/"
+Issues = "https://github.com/stac-utils/titiler-pgstac/issues"
+Source = "https://github.com/stac-utils/titiler-pgstac"
+Changelog = "https://stac-utils.github.io/titiler-pgstac/release-notes/"
+
+[build-system]
+requires = [
+    "pdm-pep517",
+]
+build-backend = "pdm.pep517.api"
+
+[tool.pdm.version]
+source = "file"
+path = "titiler/pgstac/__init__.py"
+
+[tool.pdm.build]
+includes = [
+    "titiler/pgstac",
+]
+excludes = [
+    "tests/",
+    "**/.mypy_cache",
+    "**/.DS_Store",
+]
+
+[tool.coverage.run]
+branch = true
+parallel = true
+
+[tool.coverage.report]
+exclude_lines = [
+    "no cov",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+]
+
+[tool.isort]
+profile = "black"
+known_first_party = [
+    "titiler",
+]
+known_third_party = [
+    "rasterio",
+    "morecantile",
+    "rio_tiler",
+    "cogeo_mosaic",
+    "geojson_pydantic",
+]
+default_section = "THIRDPARTY"
+
+[tool.ruff]
+select = [
+    "D1",
+    "E",
+    "W",
+    "F",
+    "C",
+    "B",
+]
+ignore = [
+    "E501",
+    "B008",
+    "B905",
+]
+
+[tool.mypy]
+no_implicit_optional = true
+strict_optional = true
+namespace_packages = true
+explicit_package_bases = true
+
+[tool.pytest.ini_options]
+filterwarnings = [
+    "ignore::rasterio.errors.NotGeoreferencedWarning",
+]

titiler.pgstac-1.2.3/titiler/pgstac/__init__.py

@@ -0,0 +1,3 @@
+"""titiler.pgstac"""
+
+__version__ = "1.2.3"

titiler.pgstac-1.2.3/titiler/pgstac/db.py

@@ -0,0 +1,43 @@
+"""Database connection handling."""
+
+from typing import Any, Dict, Optional
+
+from fastapi import FastAPI
+from psycopg_pool import ConnectionPool
+
+from titiler.pgstac.settings import PostgresSettings
+
+
+async def connect_to_db(
+    app: FastAPI,
+    settings: Optional[PostgresSettings] = None,
+    pool_kwargs: Optional[Dict[str, Any]] = None,
+) -> None:
+    """Connect to Database."""
+    if not settings:
+        settings = PostgresSettings()
+
+    pool_kwargs = (
+        pool_kwargs
+        if pool_kwargs is not None
+        else {"options": "-c search_path=pgstac,public -c application_name=pgstac"}
+    )
+
+    app.state.dbpool = ConnectionPool(
+        conninfo=str(settings.database_url),
+        min_size=settings.db_min_conn_size,
+        max_size=settings.db_max_conn_size,
+        max_waiting=settings.db_max_queries,
+        max_idle=settings.db_max_idle,
+        num_workers=settings.db_num_workers,
+        kwargs=pool_kwargs,
+    )
+
+    # Make sure the pool is ready
+    # ref: https://www.psycopg.org/psycopg3/docs/advanced/pool.html#pool-startup-check
+    app.state.dbpool.wait()
+
+
+async def close_db_connection(app: FastAPI) -> None:
+    """Close Pool."""
+    app.state.dbpool.close()