titiler


Nametitiler JSON
Version 0.18.1 PyPI version JSON
download
home_pageNone
SummaryA modern dynamic tile server built on top of FastAPI and Rasterio/GDAL.
upload_time2024-04-12 16:38:09
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseMIT License Copyright (c) 2019 Development Seed 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.
keywords cog dynamic tile server fastapi gdal mosaicjson ogc rasterio stac
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <p align="center">
  <img width="500" src="https://user-images.githubusercontent.com/10407788/172718020-c2378b7e-a0d4-406e-924c-8ffe54e61596.png"/>
  <p align="center">A modern dynamic tile server built on top of FastAPI and Rasterio/GDAL.</p>
</p>

<p align="center">
  <a href="https://github.com/developmentseed/titiler/actions?query=workflow%3ACI" target="_blank">
      <img src="https://github.com/developmentseed/titiler/workflows/CI/badge.svg" alt="Test">
  </a>
  <a href="https://codecov.io/gh/developmentseed/titiler" target="_blank">
      <img src="https://codecov.io/gh/developmentseed/titiler/branch/main/graph/badge.svg" alt="Coverage">
  </a>
  <a href="https://pypi.org/project/titiler" target="_blank">
      <img src="https://img.shields.io/pypi/v/titiler?color=%2334D058&label=pypi%20package" alt="Package version">
  </a>
  <a href="https://github.com/developmentseed/titiler/blob/main/LICENSE" target="_blank">
      <img src="https://img.shields.io/github/license/developmentseed/titiler.svg" alt="Downloads">
  </a>
  <a href="https://mybinder.org/v2/gh/developmentseed/titiler/main" target="_blank">
      <img src="https://mybinder.org/badge_logo.svg" alt="Downloads">
  </a>
  <a href="https://hub.docker.com/r/developmentseed/titiler" target="_blank">
      <img src="https://img.shields.io/docker/v/developmentseed/titiler?color=%2334D058&label=docker%20hub" alt="Docker">
  </a>
</p>

---

**Documentation**: <a href="https://devseed.com/titiler/" target="_blank">https://devseed.com/titiler/</a>

**Source Code**: <a href="https://github.com/developmentseed/titiler" target="_blank">https://github.com/developmentseed/titiler</a>

---

`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`](https://github.com/developmentseed/cogeo-tiler) and [`cogeo-mosaic-tiler`](https://github.com/developmentseed/cogeo-mosaic-tiler).

## Features

- Built on top of [FastAPI](https://fastapi.tiangolo.com)
- [Cloud Optimized GeoTIFF](http://www.cogeo.org/) support
- [SpatioTemporal Asset Catalog](https://stacspec.org) support
- Multiple projections support (see [TileMatrixSets](https://www.ogc.org/standards/tms)) via [`morecantile`](https://github.com/developmentseed/morecantile).
- JPEG / JP2 / PNG / WEBP / GTIFF / NumpyTile output format support
- OGC WMTS support
- Automatic OpenAPI documentation (FastAPI builtin)
- Virtual mosaic support (via [MosaicJSON](https://github.com/developmentseed/mosaicjson-spec/))
- 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**](https://github.com/developmentseed/titiler/tree/main/src/titiler/core) | [![titiler.core](https://img.shields.io/pypi/v/titiler.core?color=%2334D058&label=pypi)](https://pypi.org/project/titiler.core) | The `Core` package contains libraries to help create a  dynamic tiler for COG and STAC
[**titiler.extensions**](https://github.com/developmentseed/titiler/tree/main/src/titiler/extensions) | [![titiler.extensions](https://img.shields.io/pypi/v/titiler.extensions?color=%2334D058&label=pypi)](https://pypi.org/project/titiler.extensions) | TiTiler's extensions package. Contains extensions for Tiler Factories.
[**titiler.mosaic**](https://github.com/developmentseed/titiler/tree/main/src/titiler/mosaic) | [![titiler.mosaic](https://img.shields.io/pypi/v/titiler.mosaic?color=%2334D058&label=pypi)](https://pypi.org/project/titiler.mosaic) | The `mosaic` package contains libraries to help create a dynamic tiler for MosaicJSON (adds `cogeo-mosaic` requirement)
[**titiler.application**](https://github.com/developmentseed/titiler/tree/main/src/titiler/application) | [![titiler.application](https://img.shields.io/pypi/v/titiler.application?color=%2334D058&label=pypi)](https://pypi.org/project/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:

```bash
# 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.

- https://github.com/developmentseed/titiler/pkgs/container/titiler

```bash
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](https://github.com/developmentseed/titiler/blob/main/CONTRIBUTING.md)

## License

See [LICENSE](https://github.com/developmentseed/titiler/blob/main/LICENSE)

## Authors

Created by [Development Seed](<http://developmentseed.org>)

See [contributors](https://github.com/developmentseed/titiler/graphs/contributors) for a listing of individual contributors.

## Changes

See [CHANGES.md](https://github.com/developmentseed/titiler/blob/main/CHANGES.md).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "titiler",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "COG, Dynamic tile server, Fastapi, GDAL, MosaicJSON, OGC, Rasterio, STAC",
    "author": null,
    "author_email": "Vincent Sarago <vincent@developmentseed.com>",
    "download_url": "https://files.pythonhosted.org/packages/59/15/70e7a579e70b3e943504a1c9343826ceacd19b5442c1d4fba94a17ec805c/titiler-0.18.1.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <img width=\"500\" src=\"https://user-images.githubusercontent.com/10407788/172718020-c2378b7e-a0d4-406e-924c-8ffe54e61596.png\"/>\n  <p align=\"center\">A modern dynamic tile server built on top of FastAPI and Rasterio/GDAL.</p>\n</p>\n\n<p align=\"center\">\n  <a href=\"https://github.com/developmentseed/titiler/actions?query=workflow%3ACI\" target=\"_blank\">\n      <img src=\"https://github.com/developmentseed/titiler/workflows/CI/badge.svg\" alt=\"Test\">\n  </a>\n  <a href=\"https://codecov.io/gh/developmentseed/titiler\" target=\"_blank\">\n      <img src=\"https://codecov.io/gh/developmentseed/titiler/branch/main/graph/badge.svg\" alt=\"Coverage\">\n  </a>\n  <a href=\"https://pypi.org/project/titiler\" target=\"_blank\">\n      <img src=\"https://img.shields.io/pypi/v/titiler?color=%2334D058&label=pypi%20package\" alt=\"Package version\">\n  </a>\n  <a href=\"https://github.com/developmentseed/titiler/blob/main/LICENSE\" target=\"_blank\">\n      <img src=\"https://img.shields.io/github/license/developmentseed/titiler.svg\" alt=\"Downloads\">\n  </a>\n  <a href=\"https://mybinder.org/v2/gh/developmentseed/titiler/main\" target=\"_blank\">\n      <img src=\"https://mybinder.org/badge_logo.svg\" alt=\"Downloads\">\n  </a>\n  <a href=\"https://hub.docker.com/r/developmentseed/titiler\" target=\"_blank\">\n      <img src=\"https://img.shields.io/docker/v/developmentseed/titiler?color=%2334D058&label=docker%20hub\" alt=\"Docker\">\n  </a>\n</p>\n\n---\n\n**Documentation**: <a href=\"https://devseed.com/titiler/\" target=\"_blank\">https://devseed.com/titiler/</a>\n\n**Source Code**: <a href=\"https://github.com/developmentseed/titiler\" target=\"_blank\">https://github.com/developmentseed/titiler</a>\n\n---\n\n`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.\n\nNote: This project is the descendant of [`cogeo-tiler`](https://github.com/developmentseed/cogeo-tiler) and [`cogeo-mosaic-tiler`](https://github.com/developmentseed/cogeo-mosaic-tiler).\n\n## Features\n\n- Built on top of [FastAPI](https://fastapi.tiangolo.com)\n- [Cloud Optimized GeoTIFF](http://www.cogeo.org/) support\n- [SpatioTemporal Asset Catalog](https://stacspec.org) support\n- Multiple projections support (see [TileMatrixSets](https://www.ogc.org/standards/tms)) via [`morecantile`](https://github.com/developmentseed/morecantile).\n- JPEG / JP2 / PNG / WEBP / GTIFF / NumpyTile output format support\n- OGC WMTS support\n- Automatic OpenAPI documentation (FastAPI builtin)\n- Virtual mosaic support (via [MosaicJSON](https://github.com/developmentseed/mosaicjson-spec/))\n- Example of AWS Lambda / ECS deployment (via CDK)\n\n## Packages\n\nStarting with version `0.3.0`, the `TiTiler` python module has been split into a set of python namespace packages: `titiler.{package}`.\n\n| Package | Version |  Description\n| ------- | ------- |-------------\n[**titiler.core**](https://github.com/developmentseed/titiler/tree/main/src/titiler/core) | [![titiler.core](https://img.shields.io/pypi/v/titiler.core?color=%2334D058&label=pypi)](https://pypi.org/project/titiler.core) | The `Core` package contains libraries to help create a  dynamic tiler for COG and STAC\n[**titiler.extensions**](https://github.com/developmentseed/titiler/tree/main/src/titiler/extensions) | [![titiler.extensions](https://img.shields.io/pypi/v/titiler.extensions?color=%2334D058&label=pypi)](https://pypi.org/project/titiler.extensions) | TiTiler's extensions package. Contains extensions for Tiler Factories.\n[**titiler.mosaic**](https://github.com/developmentseed/titiler/tree/main/src/titiler/mosaic) | [![titiler.mosaic](https://img.shields.io/pypi/v/titiler.mosaic?color=%2334D058&label=pypi)](https://pypi.org/project/titiler.mosaic) | The `mosaic` package contains libraries to help create a dynamic tiler for MosaicJSON (adds `cogeo-mosaic` requirement)\n[**titiler.application**](https://github.com/developmentseed/titiler/tree/main/src/titiler/application) | [![titiler.application](https://img.shields.io/pypi/v/titiler.application?color=%2334D058&label=pypi)](https://pypi.org/project/titiler.application) | TiTiler's `demo` package. Contains a FastAPI application with full support of COG, STAC and MosaicJSON\n\n\n## Installation\n\nTo install from PyPI and run:\n\n```bash\n# Make sure you have pip up to date\npython -m pip install -U pip\n\npython -m pip  install titiler.{package}\n# e.g.,\n# python -m pip  install titiler.core\n# python -m pip  install titiler.extensions\n# python -m pip  install titiler.mosaic\n# python -m pip  install titiler.application (also installs core, extensions and mosaic)\n\n# Install uvicorn to run the FastAPI application locally\npython -m pip install uvicorn\n\n# Launch application locally\nuvicorn titiler.application.main:app\n```\n\nTo install from sources and run for development:\n\n```\ngit clone https://github.com/developmentseed/titiler.git\ncd titiler\n\npython -m pip install -U pip\npython -m pip install -e src/titiler/core -e src/titiler/extensions -e src/titiler/mosaic -e src/titiler/application\npython -m pip install uvicorn\n\nuvicorn titiler.application.main:app --reload\n```\n\n## Docker\n\nReady to use/deploy images can be found on Github registry.\n\n- https://github.com/developmentseed/titiler/pkgs/container/titiler\n\n```bash\ndocker run --name titiler \\\n    -p 8000:8000 \\\n    --env PORT=8000 \\\n    --env WORKERS_PER_CORE=1 \\\n    --rm -it ghcr.io/developmentseed/titiler:latest\n```\n\n- Built the docker locally\n```\ngit clone https://github.com/developmentseed/titiler.git\ncd titiler\n\ndocker-compose up --build titiler  # or titiler-uvicorn\n```\n\nSome options can be set via environment variables, see: https://github.com/tiangolo/uvicorn-gunicorn-docker#advanced-usage\n\n## Project structure\n\n```\nsrc/titiler/                     - titiler modules.\n \u251c\u2500\u2500 application/                - Titiler's `Application` package\n \u251c\u2500\u2500 extensions/                 - Titiler's `Extensions` package\n \u251c\u2500\u2500 core/                       - Titiler's `Core` package\n \u2514\u2500\u2500 mosaic/                     - Titiler's `Mosaic` package\n```\n\n## Contribution & Development\n\nSee [CONTRIBUTING.md](https://github.com/developmentseed/titiler/blob/main/CONTRIBUTING.md)\n\n## License\n\nSee [LICENSE](https://github.com/developmentseed/titiler/blob/main/LICENSE)\n\n## Authors\n\nCreated by [Development Seed](<http://developmentseed.org>)\n\nSee [contributors](https://github.com/developmentseed/titiler/graphs/contributors) for a listing of individual contributors.\n\n## Changes\n\nSee [CHANGES.md](https://github.com/developmentseed/titiler/blob/main/CHANGES.md).\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2019 Development Seed  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.",
    "summary": "A modern dynamic tile server built on top of FastAPI and Rasterio/GDAL.",
    "version": "0.18.1",
    "project_urls": {
        "Changelog": "https://developmentseed.org/titiler/release-notes/",
        "Documentation": "https://developmentseed.org/titiler/",
        "Homepage": "https://developmentseed.org/titiler/",
        "Issues": "https://github.com/developmentseed/titiler/issues",
        "Source": "https://github.com/developmentseed/titiler"
    },
    "split_keywords": [
        "cog",
        " dynamic tile server",
        " fastapi",
        " gdal",
        " mosaicjson",
        " ogc",
        " rasterio",
        " stac"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "bee7a393955752dc54416f326e245a432930244a0be00d2df3a8048b21d9c5f8",
                "md5": "bbe2fb73b54347ce8e3ff6b5980b18ad",
                "sha256": "33e46193708e3804117c220d76b674b158588f1b5f7808d60e5255462aeb68d6"
            },
            "downloads": -1,
            "filename": "titiler-0.18.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "bbe2fb73b54347ce8e3ff6b5980b18ad",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 4770,
            "upload_time": "2024-04-12T16:38:07",
            "upload_time_iso_8601": "2024-04-12T16:38:07.671944Z",
            "url": "https://files.pythonhosted.org/packages/be/e7/a393955752dc54416f326e245a432930244a0be00d2df3a8048b21d9c5f8/titiler-0.18.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "591570e7a579e70b3e943504a1c9343826ceacd19b5442c1d4fba94a17ec805c",
                "md5": "70aaf45aecb0068dd28ad8d41b912c4b",
                "sha256": "8da2959c1120bb7ab2b6bb07f896dac8e6f32b570367608d424a54ef65c9c885"
            },
            "downloads": -1,
            "filename": "titiler-0.18.1.tar.gz",
            "has_sig": false,
            "md5_digest": "70aaf45aecb0068dd28ad8d41b912c4b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 5313,
            "upload_time": "2024-04-12T16:38:09",
            "upload_time_iso_8601": "2024-04-12T16:38:09.374710Z",
            "url": "https://files.pythonhosted.org/packages/59/15/70e7a579e70b3e943504a1c9343826ceacd19b5442c1d4fba94a17ec805c/titiler-0.18.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-12 16:38:09",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "developmentseed",
    "github_project": "titiler",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "titiler"
}
        
Elapsed time: 0.25973s