Skip to content

Commit 3c9f4ca

Browse files
Merge pull request #84 from OvertureMaps/dev-guide
update README with development instructions
2 parents 6004808 + 03f35fe commit 3c9f4ca

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ until a stable release, but we will keep the documentation here up-to-date.
1616

1717
Download the building footprints for the specific bounding box as GeoJSON and save to a file named "boston.geojson"
1818

19-
```
19+
```bash
2020
overturemaps download --bbox=-71.068,42.353,-71.058,42.363 -f geojson --type=building -o boston.geojson
2121
```
2222

@@ -39,7 +39,7 @@ Command-line options:
3939
complete list of allowed types
4040
- `--connect_timeout` (optional): Socket connection timeout, in seconds. If omitted, the AWS SDK default value is used (typically 1 second).
4141
- `--request_timeout` (optional): Socket read timeouts on Windows and macOS, in seconds. If omitted, the AWS SDK default value is used (typically 3 seconds). This option is ignored on non-Windows, non-macOS systems.
42-
- `--stac/--no-stac` (optional): By default, the reader uses Overture's [STAC-geoparquet](https://stac-utils.github.io/stac-geoparquet/latest/) catalog to speed up queries. If the `--no-stac` flag is present, the data will be read normally.
42+
- `--stac/--no-stac` (optional): By default, the reader uses Overture's [STAC catalog](https://stac.overturemaps.org/) to speed up queries to the latest release. If the `--no-stac` flag is present, the CLI will use the S3 path for the latest release directly.
4343

4444
This downloads data directly from Overture's S3 bucket without interacting with any other servers.
4545
By including bounding box extents on each row in the Overture distribution, the underlying Parquet
@@ -65,18 +65,26 @@ Command-line options:
6565

6666
To install overturemaps from [PyPi](https://pypi.org/project/overturemaps/) using pip
6767

68-
```shell
68+
```bash
6969
pip install overturemaps
7070
```
7171

7272
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:
7373

74-
```shell
74+
```bash
7575
conda install -c conda-forge overturemaps
7676
```
7777

7878
If you have [uv](https://docs.astral.sh/uv/) installed, you can run overturemaps [with uvx](https://docs.astral.sh/uv/guides/tools/#running-tools) without installing it:
7979

80-
```shell
80+
```bash
8181
uvx overturemaps download --bbox=-71.068,42.353,-71.058,42.363 -f geojson --type=building -o boston.parquet
8282
```
83+
84+
## Development
85+
86+
```bash
87+
uv sync
88+
uv run pytest tests/
89+
```
90+

0 commit comments

Comments
 (0)