Metadata-Version: 2.4
Name: overture-sources
Version: 0.1.0
Summary: Deprecated, use overture-dataset-configs. Overture source registry JSON files.
Author: Overture Maps Foundation
License-Expression: MIT
Project-URL: Homepage, https://github.com/OvertureMaps/overture-providers
Project-URL: Source, https://github.com/OvertureMaps/overture-providers/tree/main/packages/overture_sources
Project-URL: Issues, https://github.com/OvertureMaps/overture-providers/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: dev
Requires-Dist: pytest>=9.1.1; extra == "dev"
Requires-Dist: pytest-cov>=7.0.0; extra == "dev"
Dynamic: license-file

# overture-sources

[![PyPI](https://img.shields.io/pypi/v/overture-sources?color=4051CC&labelColor=001A39)](https://pypi.org/project/overture-sources/)
[![Test Python](https://github.com/OvertureMaps/overture-providers/actions/workflows/test_python.yml/badge.svg?branch=main)](https://github.com/OvertureMaps/overture-providers/actions/workflows/test_python.yml)
[![Python 3.11+](https://img.shields.io/badge/Python-3.11%2B-4051CC?labelColor=001A39)](https://github.com/OvertureMaps/overture-providers/blob/main/packages/overture_sources/pyproject.toml)
[![License: MIT](https://img.shields.io/badge/license-MIT-05A5AF?labelColor=001A39)](https://github.com/OvertureMaps/overture-providers/blob/main/packages/overture_sources/LICENSE)

Overture source registry: the JSON files describing the datasets that feed each theme.

> [!WARNING]
> Deprecated in favor of [overture-dataset-configs](https://pypi.org/project/overture-dataset-configs/), which holds the same per-dataset license, attribution and coverage details. This package is kept for existing consumers of the per-theme files; new code should use the dataset configs.

```python
from overture_sources import load_sources, theme_names

theme_names()  # ["addresses", "base", ...]
load_sources("places")  # parsed overture_sources/places.json
```

## Concepts

- **Theme**: a top-level Overture data category, such as places or buildings. There is one file per theme, plus `property_descriptions`. See the [Overture schema documentation](https://docs.overturemaps.org/schema/) for what each theme contains.
- **Source**: an organization whose data contributes to a theme.
- **Dataset**: one specific collection of data from a source. Its `dataset_name` is the value that appears as `dataset` in a feature's `sources` property in Overture data.

Each theme file has a `datasets` list, with one entry per source and dataset pair, plus a `license_priority` mapping of license identifiers to a priority rank. An entry records the dataset's license, attribution, coverage, refresh cadence and the date it was first used in the theme. `property_descriptions.json` documents every field.

For the attribution and license terms as published with each release, see the [Overture attribution page](https://docs.overturemaps.org/attribution/).
