A CLI tool to quickly set up a data project with essential folders, configurations, and documentation.
# Deno
deno run --min-dep-age=0 -A jsr:@nshiab/setup-data-project
# Node
npx @nshiab/setup-data-project
# Bun
bunx @nshiab/setup-data-projectThe Deno dependency-age bypass is temporary while the 2.0 dependencies are newly published. It is tracked for removal in issue #15.
- Creates a standardized folder structure.
- Ensures necessary files like
.env,.gitignore, andREADME.mdexist. - Lets you choose between simple-data-analysis-core, the full simple-data-analysis package, and journalism libraries, then fetches their README files and complete API documentation from the matching version tags on GitHub for LLM use.
- Updates project configuration (e.g.,
deno.jsonorpackage.json) with relevant tasks.
The library is maintained by Nael Shiab, computational journalist and senior data producer for CBC News.