| Name | titiler.stacapi JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Connect titiler to STAC APIs. |
| upload_time | 2024-11-19 07:53:12 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
titiler
stac api
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# titiler-stacapi
<p align="center">
<img width="800" src="https://github.com/developmentseed/titiler-stacapi/assets/10407788/bb54162e-9a47-4a67-99e5-6dc91098e048">
<p align="center">Connect titiler to STAC APIs</p>
</p>
<p align="center">
<a href="https://github.com/developmentseed/titiler-stacapi/actions?query=workflow%3ACI" target="_blank">
<img src="https://github.com/developmentseed/titiler-stacapi/workflows/CI/badge.svg" alt="Test">
</a>
<a href="https://codecov.io/gh/developmentseed/titiler-stacapi" target="_blank">
<img src="https://codecov.io/gh/developmentseed/titiler-stacapi/branch/main/graph/badge.svg" alt="Coverage">
</a>
<a href="https://github.com/developmentseed/titiler-stacapi/blob/main/LICENSE" target="_blank">
<img src="https://img.shields.io/github/license/developmentseed/titiler-stacapi.svg" alt="License">
</a>
</p>
---
**Documentation**: <a href="https://developmentseed.org/titiler-stacapi/" target="_blank">https://developmentseed.org/titiler-stacapi/</a>
**Source Code**: <a href="https://github.com/developmentseed/titiler-stacapi" target="_blank">https://github.com/developmentseed/titiler-stacapi</a>
---
## 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.stacapi
```
or from sources and run for development:
```bash
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**](https://github.com/stac-extensions/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](https://github.com//developmentseed/titiler-stacapi/blob/main/CONTRIBUTING.md)
## License
See [LICENSE](https://github.com//developmentseed/titiler-stacapi/blob/main/LICENSE)
## Authors
See [contributors](https://github.com/developmentseed/titiler-stacapi/graphs/contributors) for a listing of individual contributors.
## Changes
See [CHANGES.md](https://github.com/developmentseed/titiler-stacapi/blob/main/CHANGES.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "titiler.stacapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "TiTiler, STAC API",
"author": null,
"author_email": "Vincent Sarago <vincent@developmentseed.com>",
"download_url": "https://files.pythonhosted.org/packages/8d/0a/1b380ef639955290ff70ce9d6f888461cd5f88bc400968061dbe6313a06c/titiler.stacapi-0.2.0.tar.gz",
"platform": null,
"description": "# titiler-stacapi\n\n<p align=\"center\">\n <img width=\"800\" src=\"https://github.com/developmentseed/titiler-stacapi/assets/10407788/bb54162e-9a47-4a67-99e5-6dc91098e048\">\n <p align=\"center\">Connect titiler to STAC APIs</p>\n</p>\n\n<p align=\"center\">\n <a href=\"https://github.com/developmentseed/titiler-stacapi/actions?query=workflow%3ACI\" target=\"_blank\">\n <img src=\"https://github.com/developmentseed/titiler-stacapi/workflows/CI/badge.svg\" alt=\"Test\">\n </a>\n <a href=\"https://codecov.io/gh/developmentseed/titiler-stacapi\" target=\"_blank\">\n <img src=\"https://codecov.io/gh/developmentseed/titiler-stacapi/branch/main/graph/badge.svg\" alt=\"Coverage\">\n </a>\n <a href=\"https://github.com/developmentseed/titiler-stacapi/blob/main/LICENSE\" target=\"_blank\">\n <img src=\"https://img.shields.io/github/license/developmentseed/titiler-stacapi.svg\" alt=\"License\">\n </a>\n</p>\n\n---\n\n**Documentation**: <a href=\"https://developmentseed.org/titiler-stacapi/\" target=\"_blank\">https://developmentseed.org/titiler-stacapi/</a>\n\n**Source Code**: <a href=\"https://github.com/developmentseed/titiler-stacapi\" target=\"_blank\">https://github.com/developmentseed/titiler-stacapi</a>\n\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\npython -m pip install titiler.stacapi\n```\n\nor from sources and run for development:\n\n```bash\ngit clone https://github.com/developmentseed/titiler-stacapi.git\ncd titiler-stacapi\npython -m pip install -e .\n```\n\n## Launch\n\nYou'll need to have `TITILER_STACAPI_STAC_API_URL` variables set in your environment pointing to your STAC API service.\n\n```\nexport TITILER_STACAPI_STAC_API_URL=https://api.stac\n```\n\n```\npython -m pip install uvicorn\n\nuvicorn titiler.stacapi.main:app --port 8000\n```\n\n### Using Docker\n\n```\n$ git clone https://github.com/developmentseed/titiler-stacapi.git\n$ cd titiler-stacapi\n$ export TITILER_STACAPI_STAC_API_URL=https://api.stac\n$ docker-compose up --build api\n```\n\nIt runs `titiler.stacapi` using Gunicorn web server.\n\n### How it works\n\n\n\n### WMTS and the Render extension\n\n`titiler-stacapi` makes extensive use of the [**Render**](https://github.com/stac-extensions/render) extension, specifically at the `Collection` level.\nBy using the render's metadata, the `/wmts` endpoint (from the `OGCWMTSFactory` factory) can populate a set of `layers` returned by the `GetCapabilities` service.\n\n\n## Contribution & Development\n\nSee [CONTRIBUTING.md](https://github.com//developmentseed/titiler-stacapi/blob/main/CONTRIBUTING.md)\n\n## License\n\nSee [LICENSE](https://github.com//developmentseed/titiler-stacapi/blob/main/LICENSE)\n\n## Authors\n\nSee [contributors](https://github.com/developmentseed/titiler-stacapi/graphs/contributors) for a listing of individual contributors.\n\n## Changes\n\nSee [CHANGES.md](https://github.com/developmentseed/titiler-stacapi/blob/main/CHANGES.md).\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Connect titiler to STAC APIs.",
"version": "0.2.0",
"project_urls": {
"Changelog": "https://developmentseed.org/titiler-stacapi/release-notes/",
"Documentation": "https://developmentseed.org/titiler-stacapi/",
"Homepage": "https://developmentseed.org/titiler-stacapi/",
"Issues": "https://github.com/developmentseed/titiler-stacapi/issues",
"Source": "https://github.com/developmentseed/titiler-stacapi"
},
"split_keywords": [
"titiler",
" stac api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "738ce3bec6558822446618a0b3567d0feec743669462de85d7fac73ebfac0c14",
"md5": "ae71ca34893bdfd2e59947a3872bcc66",
"sha256": "d36da3ba435c5a63b434be1b62ace8015e14a127b884562480fcf0315f5068a9"
},
"downloads": -1,
"filename": "titiler.stacapi-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ae71ca34893bdfd2e59947a3872bcc66",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 49302,
"upload_time": "2024-11-19T07:53:11",
"upload_time_iso_8601": "2024-11-19T07:53:11.308226Z",
"url": "https://files.pythonhosted.org/packages/73/8c/e3bec6558822446618a0b3567d0feec743669462de85d7fac73ebfac0c14/titiler.stacapi-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8d0a1b380ef639955290ff70ce9d6f888461cd5f88bc400968061dbe6313a06c",
"md5": "d448293de73116c550d574a09e6b365f",
"sha256": "34fd17f971ed5d40ece26e363df0308353163f2eb22bff661fe60da520069b85"
},
"downloads": -1,
"filename": "titiler.stacapi-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "d448293de73116c550d574a09e6b365f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 37528,
"upload_time": "2024-11-19T07:53:12",
"upload_time_iso_8601": "2024-11-19T07:53:12.361307Z",
"url": "https://files.pythonhosted.org/packages/8d/0a/1b380ef639955290ff70ce9d6f888461cd5f88bc400968061dbe6313a06c/titiler.stacapi-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-19 07:53:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "developmentseed",
"github_project": "titiler-stacapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "titiler.stacapi"
}
