Skip to main content

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.

Test Coverage Package version Downloads Downloads Docker


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

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 titiler.core The Core package contains libraries to help create a dynamic tiler for COG and STAC
titiler.extensions titiler.extensions TiTiler's extensions package. Contains extensions for Tiler Factories.
titiler.mosaic titiler.mosaic The mosaic package contains libraries to help create a dynamic tiler for MosaicJSON (adds cogeo-mosaic requirement)
titiler.application 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.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/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
 ├── 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

titiler-0.18.0.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

titiler-0.18.0-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file titiler-0.18.0.tar.gz.

File metadata

  • Download URL: titiler-0.18.0.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for titiler-0.18.0.tar.gz
Algorithm Hash digest
SHA256 8f7378ca2c3acd0cd9d8157c982277f4df3facef9f545aee67ec572c75b6a6a0
MD5 db31468a53d9d195f17aa200b5d3ea12
BLAKE2b-256 06cd6ee2537c2af5b461722db41d582d852568a446948e9ea73e5054193e249e

See more details on using hashes here.

Provenance

File details

Details for the file titiler-0.18.0-py3-none-any.whl.

File metadata

  • Download URL: titiler-0.18.0-py3-none-any.whl
  • Upload date:
  • Size: 4.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.2

File hashes

Hashes for titiler-0.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ed29cdd7330847209bc245f2bb5c4c9b25f95e5f02c8f32910f816cf713c8d62
MD5 07cd1da317ef9718e34dbfecff2c18b0
BLAKE2b-256 c454f77ca2156302888cd2805ff157ad4f2bda8e4fc8e3aa3e0d64c78b13d7cd

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page