## titiler.core
Core of Titiler's application. Contains blocks to create dynamic tile servers.
## Installation
```bash
python -m pip install -U pip
# From Pypi
python -m pip install titiler.core
# Or from sources
git clone https://github.com/developmentseed/titiler.git
cd titiler && python -m pip install -e src/titiler/core
```
## How To
```python
from fastapi import FastAPI
from titiler.core.factory import TilerFactory
# Create a FastAPI application
app = FastAPI(
description="A lightweight Cloud Optimized GeoTIFF tile server",
)
# Create a set of COG endpoints
cog = TilerFactory()
# Register the COG endpoints to the application
app.include_router(cog.router, tags=["Cloud Optimized GeoTIFF"])
```
See [titiler.application](../application) for a full example.
## Package structure
```
titiler/
└── core/
├── tests/ - Tests suite
└── titiler/core/ - `core` namespace package
├── algorithm/
| ├── base.py - ABC Base Class for custom algorithms
| ├── dem.py - Elevation data related algorithms
| └── index.py - Simple band index algorithms
├── models/
| ├── response.py - Titiler's response models
| ├── mapbox.py - Mapbox TileJSON pydantic model
| └── OGC.py - Open GeoSpatial Consortium pydantic models (TileMatrixSets...)
├── resources/
| ├── enums.py - Titiler's enumerations (e.g MediaType)
| └── responses.py - Custom Starlette's responses
├── templates/
| ├── map.html - Simple Map viewer (built with leaflet)
| └── wmts.xml - OGC WMTS document template
├── dependencies.py - Titiler FastAPI's dependencies
├── errors.py - Errors handler factory
├── middleware.py - Starlette middlewares
├── factory.py - Dynamic tiler endpoints factories
├── routing.py - Custom APIRoute class
└── utils.py - Titiler utility functions
```
Raw data
{
"_id": null,
"home_page": null,
"name": "titiler-core",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "COG, STAC, MosaicJSON, Fastapi, Dynamic tile server, GDAL, Rasterio, OGC",
"author": null,
"author_email": "Vincent Sarago <vincent@developmentseed.com>",
"download_url": "https://files.pythonhosted.org/packages/61/af/caa4aa1c14f3ccfbf7fd4595fef83f6e5550743d76bb9000d77a17b9de67/titiler_core-0.21.0.tar.gz",
"platform": null,
"description": "## titiler.core\n\nCore of Titiler's application. Contains blocks to create dynamic tile servers.\n\n## Installation\n\n```bash\npython -m pip install -U pip\n\n# From Pypi\npython -m pip install titiler.core\n\n# Or from sources\ngit clone https://github.com/developmentseed/titiler.git\ncd titiler && python -m pip install -e src/titiler/core\n```\n\n## How To\n\n```python\nfrom fastapi import FastAPI\nfrom titiler.core.factory import TilerFactory\n\n# Create a FastAPI application\napp = FastAPI(\n description=\"A lightweight Cloud Optimized GeoTIFF tile server\",\n)\n\n# Create a set of COG endpoints\ncog = TilerFactory()\n\n# Register the COG endpoints to the application\napp.include_router(cog.router, tags=[\"Cloud Optimized GeoTIFF\"])\n```\n\nSee [titiler.application](../application) for a full example.\n\n## Package structure\n\n```\ntitiler/\n \u2514\u2500\u2500 core/\n \u251c\u2500\u2500 tests/ - Tests suite\n \u2514\u2500\u2500 titiler/core/ - `core` namespace package\n \u251c\u2500\u2500 algorithm/\n | \u251c\u2500\u2500 base.py - ABC Base Class for custom algorithms\n | \u251c\u2500\u2500 dem.py - Elevation data related algorithms\n | \u2514\u2500\u2500 index.py - Simple band index algorithms\n \u251c\u2500\u2500 models/\n | \u251c\u2500\u2500 response.py - Titiler's response models\n | \u251c\u2500\u2500 mapbox.py - Mapbox TileJSON pydantic model\n | \u2514\u2500\u2500 OGC.py - Open GeoSpatial Consortium pydantic models (TileMatrixSets...)\n \u251c\u2500\u2500 resources/\n | \u251c\u2500\u2500 enums.py - Titiler's enumerations (e.g MediaType)\n | \u2514\u2500\u2500 responses.py - Custom Starlette's responses\n \u251c\u2500\u2500 templates/\n | \u251c\u2500\u2500 map.html - Simple Map viewer (built with leaflet)\n | \u2514\u2500\u2500 wmts.xml - OGC WMTS document template\n \u251c\u2500\u2500 dependencies.py - Titiler FastAPI's dependencies\n \u251c\u2500\u2500 errors.py - Errors handler factory\n \u251c\u2500\u2500 middleware.py - Starlette middlewares\n \u251c\u2500\u2500 factory.py - Dynamic tiler endpoints factories\n \u251c\u2500\u2500 routing.py - Custom APIRoute class\n \u2514\u2500\u2500 utils.py - Titiler utility functions\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A modern dynamic tile server built on top of FastAPI and Rasterio/GDAL.",
"version": "0.21.0",
"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",
" stac",
" mosaicjson",
" fastapi",
" dynamic tile server",
" gdal",
" rasterio",
" ogc"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "20eff074938a47ef7fdc06866f9b6b22a1085ba50adfe6b4a273a700b8e12dca",
"md5": "24bcacc8ace9c2795f4802af66eea585",
"sha256": "74a0b765216391c34eed6c2603801e9b65125aaaaed499beb00e88853ef4c1c1"
},
"downloads": -1,
"filename": "titiler_core-0.21.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24bcacc8ace9c2795f4802af66eea585",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 42578,
"upload_time": "2025-01-24T12:58:15",
"upload_time_iso_8601": "2025-01-24T12:58:15.622077Z",
"url": "https://files.pythonhosted.org/packages/20/ef/f074938a47ef7fdc06866f9b6b22a1085ba50adfe6b4a273a700b8e12dca/titiler_core-0.21.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "61afcaa4aa1c14f3ccfbf7fd4595fef83f6e5550743d76bb9000d77a17b9de67",
"md5": "d764e495a06731e985442eb0931ac958",
"sha256": "8ee2ce9e8c7d45c208abda1c672932dc275478d29491f1dc0945a8f53f6d2921"
},
"downloads": -1,
"filename": "titiler_core-0.21.0.tar.gz",
"has_sig": false,
"md5_digest": "d764e495a06731e985442eb0931ac958",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 36715,
"upload_time": "2025-01-24T12:58:17",
"upload_time_iso_8601": "2025-01-24T12:58:17.540669Z",
"url": "https://files.pythonhosted.org/packages/61/af/caa4aa1c14f3ccfbf7fd4595fef83f6e5550743d76bb9000d77a17b9de67/titiler_core-0.21.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-24 12:58:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "developmentseed",
"github_project": "titiler",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "titiler-core"
}
JSON
