mirror of https://github.com/apache/superset.git synced 2026-05-21 15:55:10 +00:00

Files

Evan Rusackas cb5bb69fa8 feat(country-map): build script — emit manifest.json describing outputs

Adds a manifest.json output the plugin can fetch at runtime to
populate worldview / country / region-set / composite dropdowns
dynamically. Adding a new entry to the YAML configs no longer requires
a plugin code change — re-run build.sh, manifest updates, plugin
controls reflect the new options.

Manifest schema:
  ne_pinned_tag, ne_pinned_sha, build_timestamp_utc
  worldviews: [<wv>, ...]
  admin_levels: [0, 1]
  countries_by_worldview: {<wv>: [<adm0_a3>, ...]}
  regional_aggregations: [{country, set_id, worldview, size_bytes}, ...]
  composites: [{id, worldview, size_bytes}, ...]

Sample current output:
  1 worldview (ukr), 211 countries with subdivisions, 4 regional sets,
  1 composite (france_overseas). Build pinned to NE v5.1.2.

Follow-up commit will replace the hardcoded choice tables in
controlPanel.tsx with manifest-driven options.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

2026-05-12 17:06:30 -07:00

config

feat(country-map): build script — territory_assignments transform

2026-05-12 16:27:04 -07:00

procedural

…

.gitignore

feat(country-map): minimum-viable build pipeline (NE → GeoJSON)

2026-05-12 16:00:29 -07:00

build.py

feat(country-map): build script — emit manifest.json describing outputs

2026-05-12 17:06:30 -07:00

build.sh

feat(country-map): minimum-viable build pipeline (NE → GeoJSON)

2026-05-12 16:00:29 -07:00

README.md

…

README.md

Country Map data pipeline

This directory contains the build pipeline that turns upstream Natural Earth data into the GeoJSON files consumed by @superset-ui/plugin-chart-country-map.

It replaces the legacy scripts/Country Map GeoJSON Generator.ipynb notebook. See SIP_DRAFT.md in the parent directory for the full design rationale.

Layout

scripts/
  build.sh                   # one-shot reproducible build
  README.md                  # this file
  config/                    # declarative YAML — handles ~95% of fixes
    name_overrides.yaml      # typos, deprecated ISO codes, admin renames
    flying_islands.yaml      # repositioning + bbox drops for far-flung territories
    territory_assignments.yaml   # add features from sibling Admin 0 records
    regional_aggregations.yaml   # dissolve Admin 1 into administrative regions
    composite_maps.yaml      # multi-country composites (e.g. France-with-Overseas)
  procedural/                # escape hatch — handles the rare 5%
    README.md                # when to use, when not
    NN_<descriptive_name>.py # one focused script per genuine edge case
  output/                    # gitignored — build artifacts

Operating principles

Default tool: declarative YAML. Most touchups are renames, repositions, dissolves, or filters — all expressible in YAML. Diffs are small, conflicts localize cleanly to one entry, contributors can submit "fix typo X" as a one-line PR.
Escape hatch: procedural/ directory of small, named, single-purpose Python scripts for the rare cases YAML can't express cleanly. Each script has a header comment explaining why it's not in YAML. See procedural/README.md for the bar.
Build is reproducible from a pinned NE version. build.sh records the NE git SHA it consumed; outputs are deterministic given inputs.
CI regenerates on schema change and opens a PR if outputs differ. Maintainers review the cartographic diff in legible GeoJSON, not opaque notebook JSON.

Workflow for adding a fix

Identify the upstream NE issue (wrong name, missing territory, etc.).
Try YAML first. Add the smallest possible entry to the appropriate config file with a description field explaining the fix.
If YAML can't express it cleanly, add a numbered script in procedural/ with a header comment explaining why YAML didn't fit.
Run build.sh locally, verify the output GeoJSON looks right.
Open PR. Reviewer sees the YAML diff (or new procedural script) plus the regenerated GeoJSON.

README.md

Country Map data pipeline

Layout

Operating principles

Workflow for adding a fix

See also