Commit d1123a1
committed
feat: add overture-schema-cli package
Introduce a command-line interface for working with Overture schema
models. The CLI provides tools for schema introspection, validation,
and JSON Schema generation.
Commands:
list-types [--theme THEME] [--detailed]
List registered Overture types, optionally filtered by theme.
With --detailed, shows model descriptions from docstrings.
json-schema [--theme THEME] [--type TYPE]
Generate JSON Schema for specified themes/types or all models.
validate [--theme THEME] [--type TYPE] [--show-field FIELD] FILE
Validate GeoJSON features against Overture schemas. Supports:
- Single features and FeatureCollections
- Heterogeneous collections (mixed types)
- JSONL input from stdin (use '-' as FILE)
- Automatic type detection via discriminator fields
- Rich error display with data context windows
Type Resolution:
When --type is not specified, the validator builds a discriminated
union from registered models and uses Pydantic's tagged union support
to identify the most likely type. For heterogeneous collections, each
feature is validated against its detected type independently.
Error Display:
Validation errors show surrounding data context to help locate issues.
The --show-field option pins specific fields (e.g., id) in the display
header for easier identification in large datasets.
Pipeline Support:
The validate command accepts JSONL on stdin for integration with tools
like jq and gpq:
gpq convert file.geoparquet --to geojson | \
jq -c '.features[]' | \
overture-schema validate --type building -
Module Structure:
- commands.py: Click command definitions
- type_analysis.py: Union type construction and discriminator handling
- error_formatting.py: Validation error processing and display
- data_display.py: Context window and field extraction
- output.py: Rich console output helpers1 parent ecd2250 commit d1123a1
File tree
28 files changed
+4997
-128
lines changed- packages
- overture-schema-annex
- src/overture/schema/annex
- overture-schema-cli
- src/overture
- schema
- cli
- tests
- overture-schema
28 files changed
+4997
-128
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | | - | |
3 | | - | |
4 | | - | |
5 | | - | |
| 2 | + | |
6 | 3 | | |
7 | 4 | | |
8 | 5 | | |
| |||
24 | 21 | | |
25 | 22 | | |
26 | 23 | | |
27 | | - | |
| 24 | + | |
28 | 25 | | |
29 | 26 | | |
30 | 27 | | |
| |||
Lines changed: 0 additions & 122 deletions
This file was deleted.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
Lines changed: 1 addition & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
Lines changed: 1 addition & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
Lines changed: 31 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
Lines changed: 6 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
0 commit comments