Skip to content

Latest commit

 

History

History
95 lines (63 loc) · 2.94 KB

README.md

File metadata and controls

95 lines (63 loc) · 2.94 KB
Raw

titiler-stacapi

Connect titiler to STAC APIs

Test Coverage License

Documentation: https://developmentseed.org/titiler-stacapi/

Source Code: https://github.com/developmentseed/titiler-stacapi

Installation

To install from PyPI and run:

# Make sure you have pip up to date
python -m pip install -U pip
python -m pip  install titiler.stacapi

or from sources and run for development:

git clone https://github.com/developmentseed/titiler-stacapi.git
cd titiler-stacapi
python -m pip install -e .

Launch

You'll need to have TITILER_STACAPI_STAC_API_URL variables set in your environment pointing to your STAC API service.

export TITILER_STACAPI_STAC_API_URL=https://api.stac

python -m pip install uvicorn

uvicorn titiler.stacapi.main:app --port 8000

Using Docker

$ git clone https://github.com/developmentseed/titiler-stacapi.git
$ cd titiler-stacapi
$ export TITILER_STACAPI_STAC_API_URL=https://api.stac
$ docker-compose up --build api

It runs titiler.stacapi using Gunicorn web server.

How it works

WMTS and the Render extension

titiler-stacapi makes extensive use of the Render extension, specifically at the Collection level. By using the render's metadata, the /wmts endpoint (from the OGCWMTSFactory factory) can populate a set of layers returned by the GetCapabilities service.

Contribution & Development

See CONTRIBUTING.md

License

See LICENSE

Authors

See contributors for a listing of individual contributors.

Changes

See CHANGES.md.