| Name | overturemaps JSON |
| Version |
0.12.0
JSON |
| download |
| home_page | None |
| Summary | Python tools for interacting with Overture Maps (overturemaps.org) data. |
| upload_time | 2024-12-20 20:00:59 |
| maintainer | None |
| docs_url | None |
| author | Jacob Wasserman |
| requires_python | <4.0,>=3.8 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pypi.python.org/pypi/overturemaps)
# overturemaps-py
Official Python command-line tool of the [Overture Maps Foundation](https://overturemaps.org)
Overture Maps provides free and open geospatial map data, from many different sources and normalized to a
[common schema](https://github.com/OvertureMaps/schema). This tool helps to download Overture data
within a region of interest and converts it to a few different file formats. For more information about accessing
Overture Maps data, see our official documentation site https://docs.overturemaps.org.
Note: This repository and project are experimental. Things are likely change including the user interface
until a stable release, but we will keep the documentation here up-to-date.
## Quick Start
Download the building footprints for the specific bounding box as GeoJSON and save to a file named "boston.geojson"
```
$ overturemaps download --bbox=-71.068,42.353,-71.058,42.363 -f geojson --type=building -o boston.geojson
```
## Usage
#### `download`
There is currently one option to the `overturemaps` utility, `download`. It will download Overture Maps data
with an optional bounding box into the specified file format. When specifying a bounding box,
only the minimum data is transferred. The result is streamed out and can handle arbitrarily
large bounding boxes.
Command-line options:
* `--bbox` (optional): west, south, east, north longitude and latitude coordinates. When omitted the
entire dataset for the specified type will be downloaded
* `-f` (required: one of "geojson", "geojsonseq", "geoparquet"): output format
* `--output`/`-o` (optional): Location of output file. When omitted output will be written to stdout.
* `--type`/`-t` (required): The Overture map data type to be downloaded. Examples of types are `building`
for building footprints, `place` for POI places data, etc. Run `overturemaps download --help` for the
complete list of allowed types
This downloads data directly from Overture's S3 bucket without interacting with any other servers.
By including bounding box extents on each row in the Overture distribution, the underlying Parquet
readers use the Parquet summary statistics to download the minimum amount of data
necessary to extract data from the desired region.
To help find bounding boxes of interest, we like this [bounding box tool](https://boundingbox.klokantech.com/)
from [Klokantech](https://www.klokantech.com/). Choose the CSV format and copy the value directly into
the `--bbox` field here.
## Installation
To install overturemaps from [PyPi](https://pypi.org/project/overturemaps/) using pip
```shell
pip install overturemaps
```
overturemaps is also on [conda-forge](https://anaconda.org/conda-forge/overturemaps) and can be installed using conda, mamba, or pixi. To install overturemaps using conda:
```shell
conda install -c conda-forge overturemaps
```
Raw data
{
"_id": null,
"home_page": null,
"name": "overturemaps",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Jacob Wasserman",
"author_email": "jwasserman@meta.com",
"download_url": "https://files.pythonhosted.org/packages/49/53/9005426a5193e7a22df68dc746b1885c79dd909ce955142b8e8ef91144e2/overturemaps-0.12.0.tar.gz",
"platform": null,
"description": "[](https://pypi.python.org/pypi/overturemaps)\n\n# overturemaps-py\n\nOfficial Python command-line tool of the [Overture Maps Foundation](https://overturemaps.org)\n\nOverture Maps provides free and open geospatial map data, from many different sources and normalized to a\n[common schema](https://github.com/OvertureMaps/schema). This tool helps to download Overture data\nwithin a region of interest and converts it to a few different file formats. For more information about accessing\nOverture Maps data, see our official documentation site https://docs.overturemaps.org.\n\nNote: This repository and project are experimental. Things are likely change including the user interface\nuntil a stable release, but we will keep the documentation here up-to-date.\n\n## Quick Start\n\nDownload the building footprints for the specific bounding box as GeoJSON and save to a file named \"boston.geojson\"\n\n```\n$ overturemaps download --bbox=-71.068,42.353,-71.058,42.363 -f geojson --type=building -o boston.geojson\n```\n\n## Usage\n\n#### `download`\nThere is currently one option to the `overturemaps` utility, `download`. It will download Overture Maps data\nwith an optional bounding box into the specified file format. When specifying a bounding box,\nonly the minimum data is transferred. The result is streamed out and can handle arbitrarily\nlarge bounding boxes.\n\nCommand-line options:\n* `--bbox` (optional): west, south, east, north longitude and latitude coordinates. When omitted the\nentire dataset for the specified type will be downloaded\n* `-f` (required: one of \"geojson\", \"geojsonseq\", \"geoparquet\"): output format\n* `--output`/`-o` (optional): Location of output file. When omitted output will be written to stdout.\n* `--type`/`-t` (required): The Overture map data type to be downloaded. Examples of types are `building`\nfor building footprints, `place` for POI places data, etc. Run `overturemaps download --help` for the\ncomplete list of allowed types\n\nThis downloads data directly from Overture's S3 bucket without interacting with any other servers. \nBy including bounding box extents on each row in the Overture distribution, the underlying Parquet\nreaders use the Parquet summary statistics to download the minimum amount of data\nnecessary to extract data from the desired region.\n\nTo help find bounding boxes of interest, we like this [bounding box tool](https://boundingbox.klokantech.com/)\nfrom [Klokantech](https://www.klokantech.com/). Choose the CSV format and copy the value directly into\nthe `--bbox` field here.\n\n\n## Installation\n\nTo install overturemaps from [PyPi](https://pypi.org/project/overturemaps/) using pip\n\n```shell\npip install overturemaps\n```\n\noverturemaps is also on [conda-forge](https://anaconda.org/conda-forge/overturemaps) and can be installed using conda, mamba, or pixi. To install overturemaps using conda:\n\n```shell\nconda install -c conda-forge overturemaps\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python tools for interacting with Overture Maps (overturemaps.org) data.",
"version": "0.12.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ad78866a6e0a00a19667d09c2af9505fca8c4dcd134fa8e693c6e34c4d7d758",
"md5": "ead66fd5f4d71556caa6da070d086089",
"sha256": "9d04d5ac9d3562ab84f83650fb199607d548950a0ed1c03a890fd727c032b931"
},
"downloads": -1,
"filename": "overturemaps-0.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ead66fd5f4d71556caa6da070d086089",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 9933,
"upload_time": "2024-12-20T20:00:56",
"upload_time_iso_8601": "2024-12-20T20:00:56.848506Z",
"url": "https://files.pythonhosted.org/packages/9a/d7/8866a6e0a00a19667d09c2af9505fca8c4dcd134fa8e693c6e34c4d7d758/overturemaps-0.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "49539005426a5193e7a22df68dc746b1885c79dd909ce955142b8e8ef91144e2",
"md5": "fc5e37a559b07363a08be63535f25281",
"sha256": "36bf1907903c78f248ebd20be0cce39b3db614bcec4c675f3fe793480a827287"
},
"downloads": -1,
"filename": "overturemaps-0.12.0.tar.gz",
"has_sig": false,
"md5_digest": "fc5e37a559b07363a08be63535f25281",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 9694,
"upload_time": "2024-12-20T20:00:59",
"upload_time_iso_8601": "2024-12-20T20:00:59.854454Z",
"url": "https://files.pythonhosted.org/packages/49/53/9005426a5193e7a22df68dc746b1885c79dd909ce955142b8e8ef91144e2/overturemaps-0.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 20:00:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "overturemaps"
}
