A modern dynamic tile server built on top of FastAPI and Rasterio/GDAL.
Project description
A modern dynamic tile server built on top of FastAPI and Rasterio/GDAL.
Documentation: https://devseed.com/titiler/
Source Code: https://github.com/developmentseed/titiler
Titiler
, pronounced tee-tiler (ti is the diminutive version of the french petit which means small), is a set of python modules that focus on creating FastAPI application for dynamic tiling.
Note: This project is the descendant of cogeo-tiler
and cogeo-mosaic-tiler
.
Features
- Built on top of FastAPI
- Cloud Optimized GeoTIFF support
- SpatioTemporal Asset Catalog support
- Multiple projections support (see TileMatrixSets) via
morecantile
. - JPEG / JP2 / PNG / WEBP / GTIFF / NumpyTile output format support
- OGC WMTS support
- Automatic OpenAPI documentation (FastAPI builtin)
- Virtual mosaic support (via MosaicJSON)
- Example of AWS Lambda / ECS deployment (via CDK)
Packages
Starting with version 0.3.0
, the TiTiler
python module has been split into a set of python namespace packages: titiler.{package}
.
Package | Version | Description |
---|---|---|
titiler.core | The Core package contains libraries to help create a dynamic tiler for COG and STAC |
|
titiler.xarray | The xarray package contains libraries to help create a dynamic tiler for Zarr/NetCDF datasets |
|
titiler.extensions | TiTiler's extensions package. Contains extensions for Tiler Factories. | |
titiler.mosaic | The mosaic package contains libraries to help create a dynamic tiler for MosaicJSON (adds cogeo-mosaic requirement) |
|
titiler.application | TiTiler's demo package. Contains a FastAPI application with full support of COG, STAC and MosaicJSON |
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.{package}
# e.g.,
# python -m pip install titiler.core
# python -m pip install titiler.xarray
# python -m pip install titiler.extensions
# python -m pip install titiler.mosaic
# python -m pip install titiler.application (also installs core, extensions and mosaic)
# Install uvicorn to run the FastAPI application locally
python -m pip install uvicorn
# Launch application locally
uvicorn titiler.application.main:app
To install from sources and run for development:
git clone https://github.com/developmentseed/titiler.git
cd titiler
python -m pip install -U pip
python -m pip install -e src/titiler/core -e src/titiler/xarray -e src/titiler/extensions -e src/titiler/mosaic -e src/titiler/application
python -m pip install uvicorn
uvicorn titiler.application.main:app --reload
Docker
Ready to use/deploy images can be found on Github registry.
docker run --name titiler \
-p 8000:8000 \
--env PORT=8000 \
--env WORKERS_PER_CORE=1 \
--rm -it ghcr.io/developmentseed/titiler:latest
- Built the docker locally
git clone https://github.com/developmentseed/titiler.git
cd titiler
docker compose up --build titiler # or titiler-uvicorn
Some options can be set via environment variables, see: https://github.com/tiangolo/uvicorn-gunicorn-docker#advanced-usage
Project structure
src/titiler/ - titiler modules.
├── application/ - Titiler's `Application` package
├── extensions/ - Titiler's `Extensions` package
├── xarray/ - Titiler's `Xarray` package
├── core/ - Titiler's `Core` package
└── mosaic/ - Titiler's `Mosaic` package
Contribution & Development
See CONTRIBUTING.md
License
See LICENSE
Authors
Created by Development Seed
See contributors for a listing of individual contributors.
Changes
See CHANGES.md.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file titiler-0.19.0.tar.gz
.
File metadata
- Download URL: titiler-0.19.0.tar.gz
- Upload date:
- Size: 6.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0f3569cd838e148cb40c0f69b0fff8ef1680daf29101fda3a63a23aafb344a13 |
|
MD5 | c02ccef315f66f9b01b2548b8955c3b9 |
|
BLAKE2b-256 | 96918cce81adad444ae7c35f7d42b56d5bb976352bdcecc49c6525af02d28bd4 |
File details
Details for the file titiler-0.19.0-py3-none-any.whl
.
File metadata
- Download URL: titiler-0.19.0-py3-none-any.whl
- Upload date:
- Size: 4.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.12.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0153fb3c356a5f6fac1b4aba73b8703ffd0db63560bdb450bf87fbbd00f254ce |
|
MD5 | 9a99701fd84d2ab45e26e1bdface0512 |
|
BLAKE2b-256 | c762b57a942491d486af0495a06fcc83d00d2e62a541c2f1ee67ecaec7c59b18 |