| Name | raster-footprint JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | |
| Summary | Create GeoJSON geometries that bound the extents of valid data in a raster. |
| upload_time | 2023-09-26 11:29:05 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
geojson
footprint
rasterio
shapely
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# raster-footprint
[](https://github.com/pjhartzell/raster-footprint/actions/workflows/ci.yaml)
[](https://raster-footprint.readthedocs.io/en/latest/)
[](https://pypi.org/project/raster-footprint/)
[](https://github.com/pjhartzell/raster-footprint/blob/main/LICENSE)
Create GeoJSON geometries that bound valid raster data. Depends on [rasterio](https://rasterio.readthedocs.io/en/stable/) and [shapely](https://shapely.readthedocs.io/en/stable/manual.html).
## Usage
```shell
pip install raster-footprint
```
Create or manipulate GeoJSON with the CLI:
```shell
raster-footprint --help
usage: raster-footprint [-h] {create,densify,reproject,simplify} ...
options:
-h, --help show this help message and exit
commands:
{create,densify,reproject,simplify}
create Create a raster footprint
densify Densify a Polygon or MultiPolygon
reproject Reproject a Polygon or MultiPolygon
simplify Simplify a Polygon or MultiPolygon
```
Import `raster_footprint` functions into your Python script:
```Python
from raster_footprint import footprint_from_href
footprint = footprint_from_href(
"my_raster.tif",
densify_distance=100,
simplify_tolerance=0.001,
holes=False
)
```
See the [API documentation](https://raster-footprint.readthedocs.io/) for available functions and options.
## Developing
Clone and install in editable mode with the development optional dependencies:
```shell
git clone https://github.com/pjhartzell/raster-footprint
cd raster-footprint
pip install -e ".[dev,docs]"
```
We use [pytest](https://docs.pytest.org/) for tests:
```shell
pytest
```
We use [Sphinx](https://www.sphinx-doc.org/) for docs:
```shell
make -C docs html
```
## Contributing
Github [issues](https://github.com/pjhartzell/raster-footprint/issues) and [pull requests](https://github.com/pjhartzell/raster-footprint/pulls).
## License
[Apache-2.0](https://github.com/pjhartzell/raster-footprint/blob/main/LICENSE)
Raw data
{
"_id": null,
"home_page": "",
"name": "raster-footprint",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "geojson,footprint,rasterio,shapely",
"author": "",
"author_email": "Preston Hartzell <preston.hartzell@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/86/95/36e9c62eb5dfba41df7f9c38108a13bba504cadf7be6aadb85f4c40a4816/raster-footprint-0.2.0.tar.gz",
"platform": null,
"description": "# raster-footprint\n\n[](https://github.com/pjhartzell/raster-footprint/actions/workflows/ci.yaml)\n[](https://raster-footprint.readthedocs.io/en/latest/)\n[](https://pypi.org/project/raster-footprint/)\n\n[](https://github.com/pjhartzell/raster-footprint/blob/main/LICENSE)\n\nCreate GeoJSON geometries that bound valid raster data. Depends on [rasterio](https://rasterio.readthedocs.io/en/stable/) and [shapely](https://shapely.readthedocs.io/en/stable/manual.html).\n\n## Usage\n\n```shell\npip install raster-footprint\n```\n\nCreate or manipulate GeoJSON with the CLI:\n\n```shell\nraster-footprint --help\nusage: raster-footprint [-h] {create,densify,reproject,simplify} ...\n\noptions:\n -h, --help show this help message and exit\n\ncommands:\n {create,densify,reproject,simplify}\n create Create a raster footprint\n densify Densify a Polygon or MultiPolygon\n reproject Reproject a Polygon or MultiPolygon\n simplify Simplify a Polygon or MultiPolygon\n```\n\nImport `raster_footprint` functions into your Python script:\n\n```Python\nfrom raster_footprint import footprint_from_href\n\nfootprint = footprint_from_href(\n \"my_raster.tif\",\n densify_distance=100,\n simplify_tolerance=0.001,\n holes=False\n)\n```\n\nSee the [API documentation](https://raster-footprint.readthedocs.io/) for available functions and options.\n\n## Developing\n\nClone and install in editable mode with the development optional dependencies:\n\n```shell\ngit clone https://github.com/pjhartzell/raster-footprint\ncd raster-footprint\npip install -e \".[dev,docs]\"\n```\n\nWe use [pytest](https://docs.pytest.org/) for tests:\n\n```shell\npytest\n```\n\nWe use [Sphinx](https://www.sphinx-doc.org/) for docs:\n\n```shell\nmake -C docs html\n```\n\n## Contributing\n\nGithub [issues](https://github.com/pjhartzell/raster-footprint/issues) and [pull requests](https://github.com/pjhartzell/raster-footprint/pulls).\n\n## License\n\n[Apache-2.0](https://github.com/pjhartzell/raster-footprint/blob/main/LICENSE)\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Create GeoJSON geometries that bound the extents of valid data in a raster.",
"version": "0.2.0",
"project_urls": {
"Changelog": "https://github.com/pjhartzell/raster-footprint/blob/main/CHANGELOG.md",
"Documentation": "https://raster-footprint.readthedocs.io",
"GitHub": "https://github.com/pjhartzell/raster-footprint"
},
"split_keywords": [
"geojson",
"footprint",
"rasterio",
"shapely"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "12aa94d611656dd489ac6ff5c49c1019611b55b3dd5d0e61d9345665682e74bb",
"md5": "031b53e62d85710278127be90e16c7af",
"sha256": "939fcffd16ea5af459db895e0a59d59cf5deea26c62fc98819795ae171e2b57a"
},
"downloads": -1,
"filename": "raster_footprint-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "031b53e62d85710278127be90e16c7af",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 15960,
"upload_time": "2023-09-26T11:28:58",
"upload_time_iso_8601": "2023-09-26T11:28:58.962589Z",
"url": "https://files.pythonhosted.org/packages/12/aa/94d611656dd489ac6ff5c49c1019611b55b3dd5d0e61d9345665682e74bb/raster_footprint-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "869536e9c62eb5dfba41df7f9c38108a13bba504cadf7be6aadb85f4c40a4816",
"md5": "1382d986cce025b996830fe0ab2d920e",
"sha256": "e582111ce4c8408060e3d746a305e70075de4ee240617e2a0bcca38f3c99beb9"
},
"downloads": -1,
"filename": "raster-footprint-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "1382d986cce025b996830fe0ab2d920e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 18064,
"upload_time": "2023-09-26T11:29:05",
"upload_time_iso_8601": "2023-09-26T11:29:05.014426Z",
"url": "https://files.pythonhosted.org/packages/86/95/36e9c62eb5dfba41df7f9c38108a13bba504cadf7be6aadb85f4c40a4816/raster-footprint-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-26 11:29:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pjhartzell",
"github_project": "raster-footprint",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "raster-footprint"
}
