Skip to content

Commit

Permalink
Rename "OSM data" example to "OpenStreetMap data" (#8076)
Browse files Browse the repository at this point in the history
### What

Tittle change for better legibility and, in particular, spelling the
"Map" word full for discoverability.

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8076?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/8076?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/8076)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.
  • Loading branch information
abey79 authored Nov 12, 2024
1 parent e856784 commit a4c5cf4
Show file tree
Hide file tree
Showing 8 changed files with 47 additions and 520 deletions.
2 changes: 1 addition & 1 deletion examples/manifest.toml
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ examples = [
"clock",
"dna",
"log_file",
"osm_data",
"openstreetmap_data",
"minimal",
"multiprocess_logging",
"multithreading",
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<!--[metadata]
title = "OSM data"
title = "OpenStreetMap data"
tags = ["Map", "Blueprint"]
thumbnail_dimensions = [480, 480]
thumbnail = "https://static.rerun.io/osm_data/0be94071469c49f98326d85456ed2a3af8d1733a/480w.png"
Expand Down Expand Up @@ -29,13 +29,13 @@ git checkout latest # Check out the commit matching the latest SDK release
```
Install the necessary libraries specified in the requirements file:
```bash
pip install -e examples/python/osm_data
pip install -e examples/python/openstreetmap_data
```
To experiment with the provided example, simply execute the main Python script:
```bash
python -m osm_data # run the example
python -m openstreetmap_data # run the example
```
If you wish to customize it, explore additional features, or save it use the CLI with the `--help` option for guidance:
```bash
python -m osm_data --help
python -m openstreetmap_data --help
```
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ def log_data(data: dict[str, Any]) -> None:


def main() -> None:
parser = ArgumentParser(description="Visualize OSM data")
parser = ArgumentParser(description="Visualize OpenStreetMap data")
rr.script_add_args(parser)
args = parser.parse_args()

Expand All @@ -94,7 +94,7 @@ def main() -> None:
collapse_panels=True,
)

rr.script_setup(args, "rerun_example_osm_data", default_blueprint=blueprint)
rr.script_setup(args, "rerun_example_openstreetmap_data", default_blueprint=blueprint)

data = execute_query(HOTELS_IN_LAUSANNE_QUERY)
log_data(data)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[project]
name = "osm_data"
name = "openstreetmap_data"
version = "0.1.0"
readme = "README.md"
dependencies = ["requests", "rerun-sdk"]

[project.scripts]
osm_data = "osm_data:main"
openstreetmap_data = "openstreetmap_data:main"

[build-system]
requires = ["hatchling"]
Expand Down
2 changes: 1 addition & 1 deletion lychee.toml
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ exclude = [
'https://fonts.gstatic.com/', # Font API entrypoint, not a link.
'https://tel.rerun.io/', # Analytics endpoint.
'https://docs-assets.developer.apple.com/ml-research/datasets/arkitscenes/v1', # Used by arkit_scenes.
'https://overpass-api.de/api/interpreter', # Used by osm_data example
'https://overpass-api.de/api/interpreter', # Used by openstreetmap_data example

# Avoid rate limiting.
'https://crates.io/crates/.*', # Avoid crates.io rate-limiting
Expand Down
Loading

0 comments on commit a4c5cf4

Please sign in to comment.