Migrates Superset's example data system from Python-based scripts to YAML configuration files, providing a cleaner, more maintainable approach to managing example datasets, charts, and dashboards.
- Converted 9 Python example modules to YAML configurations
- Exported existing examples from database and added as YAML files:
- 11 dashboards (USA Births Names, World Bank's Data, etc.)
- 115 charts
- 25 datasets
- Moved test-specific fixtures to `tests/fixtures/examples/`
- Removed theme_id from dashboard exports for compatibility
- **New command group**: `superset examples` with subcommands:
- `load` - Load example data (replaces `load-examples`)
- `clear-old` - Remove old Python-based examples
- `clear` - Placeholder for future YAML clearing
- `reload` - Clear and reload in one command
- **Backwards compatibility**: `superset load-examples` still works with deprecation warning
- **Safety mechanism**: Detects old examples and preserves them to avoid data loss
- Fixed JSON data loading - examples can now load `.json.gz` files from CDN
- Fixed Docker compose configuration for isolated development
- Fixed webpack WebSocket configuration for different ports
- Import operations now log what's being created vs updated:
- "Creating new dashboard: Sales Dashboard"
- "Updating existing chart: World's Population"
- Provides clear visibility into the import process
- Moved import logging to individual import functions (DRY principle)
- Non-destructive migration approach - no user data is deleted
- Deterministic UUID generation for consistent example data
- Tested migration from old Python examples to new YAML format
- Verified safety mechanism prevents accidental data overwrites
- Confirmed backwards compatibility with deprecated command
- All pre-commit checks pass
- Updated installation docs to use new CLI commands
- Added deprecation notice to UPDATING.md
- Updated development documentation
None - the old `load-examples` command continues to work with a deprecation warning.
For users with existing Python-based examples:
1. Run `superset examples clear-old --confirm` to remove old examples
2. Run `superset examples load` to load new YAML-based examples
* feat: command to import configuration from a directory
This allows us to keep Superset updated from a repo:
```bash
$ superset import-directory /path/to/configs/
```
For example, I created a simple dashboard with a single chart:
PLACEHOLDER
I then exported it to a file `dashboard_export_20210714T104600.zip` and
unzipped it. After deleting the dashboard, chart, dataset, and database
I imported everything back with:
```bash
$ superset import-directory ~/Downloads/dashboard_export_20210714T104600/
```
I then changed the chart title in `~/Downloads/dashboard_export_20210714T104600/charts/Cnt_per_country_1.yaml` and ran the command again. The chart was succesfully updated:
PLACEHOLDER
* Small fixes
