Skip to content

docs: usa comandi CLI visibili — toolkit status → inspect summary #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Gabrymi93 merged 1 commit into from
Jun 24, 2026
Merged

docs: usa comandi CLI visibili — toolkit status → inspect summary #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ La struttura resta invariata. Non serve capire tutto subito: qui trovi la base p
pip install dataciviclab-toolkit
toolkit run all --config dataset.yml
toolkit validate all --config dataset.yml
toolkit status --dataset <dataset> --year <year> --latest --config dataset.yml
toolkit inspect summary --dataset <dataset> --year <year> --latest --config dataset.yml
```

I notebook del template usano anche:
Expand Down
2 changes: 1 addition & 1 deletion WORKFLOW.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ GitHub resta il posto dove deve restare la traccia utile.
1. valida la config con `py -m pytest tests/test_contract.py`
2. esegui `toolkit run all --config dataset.yml`
3. esegui `toolkit validate all --config dataset.yml`
4. esegui `toolkit status --dataset <dataset> --year <year> --latest --config dataset.yml`
4. esegui `toolkit inspect summary --dataset <dataset> --year <year> --latest --config dataset.yml`
5. usa `toolkit inspect paths --config dataset.yml --year <year> --json`
6. usa i notebook per ispezionare RAW, CLEAN, MART e QA

Expand Down
6 changes: 3 additions & 3 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Su Windows, se `sh` non e disponibile nel `PATH`, usa una shell POSIX come Git B
```powershell
toolkit run all --config dataset.yml
toolkit validate all --config dataset.yml
toolkit status --dataset <dataset> --year <year> --latest --config dataset.yml
toolkit inspect summary --dataset <dataset> --year <year> --latest --config dataset.yml
```

## Dove scrivere cosa
Expand Down Expand Up @@ -85,7 +85,7 @@ La destinazione su Drive mantiene gli stessi path relativi sotto `root`, quindi
```sh
toolkit run all --config dataset.yml
toolkit validate all --config dataset.yml
toolkit status --dataset <dataset> --year <year> --latest --config dataset.yml
toolkit inspect summary --dataset <dataset> --year <year> --latest --config dataset.yml
toolkit inspect paths --config dataset.yml --year <year> --json
```

Expand Down Expand Up @@ -120,7 +120,7 @@ Queste fasi non sono una catena rigida: spesso bastano 2-4 issue piccole per far
| Sources/RAW | `dataset.yml`, `docs/sources.md`, `docs/decisions.md` | `toolkit run raw --config dataset.yml`, poi `toolkit inspect paths --config dataset.yml --year <year> --json` | `01_inspect_raw.ipynb` |
| CLEAN | `sql/clean.sql`, `dataset.yml`, `docs/data_dictionary.md` | `toolkit run clean --config dataset.yml`, poi `toolkit inspect paths --config dataset.yml --year <year> --json` | `02_inspect_clean.ipynb` |
| MART | `sql/mart/*.sql`, `dataset.yml` | `toolkit run mart --config dataset.yml`, poi `toolkit inspect paths --config dataset.yml --year <year> --json` | `03_explore_mart.ipynb` |
| Release | `README.md`, `docs/overview.md`, `docs/data_dictionary.md` | `toolkit status --dataset <dataset> --year <year> --latest --config dataset.yml` | `00_quickstart.ipynb` |
| Release | `README.md`, `docs/overview.md`, `docs/data_dictionary.md` | `toolkit inspect summary --dataset <dataset> --year <year> --latest --config dataset.yml` | `00_quickstart.ipynb` |
| Maintenance | `dataset.yml`, `sql/`, `docs/`, `tests/test_contract.py` | `toolkit run all --config dataset.yml` | `01_inspect_raw.ipynb`, `02_inspect_clean.ipynb`, `03_explore_mart.ipynb` |

I notebook usano `toolkit inspect paths --config dataset.yml --year <year> --json` come contratto stabile per localizzare gli output.
Expand Down
2 changes: 1 addition & 1 deletion scripts/smoke.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,5 +106,5 @@ echo "YEAR=${YEAR}"

run_toolkit run all --config "${DATASET_FILE}"
run_toolkit validate all --config "${DATASET_FILE}"
run_toolkit status --dataset "${DATASET_NAME}" --year "${YEAR}" --latest --config "${DATASET_FILE}"
run_toolkit inspect summary --dataset "${DATASET_NAME}" --year "${YEAR}" --latest --config "${DATASET_FILE}"
run_toolkit inspect paths --config "${DATASET_FILE}" --year "${YEAR}" --json
Loading