Skip to content

Repository files navigation

setup-data-project

A CLI tool to quickly set up a data project with essential folders, configurations, and documentation.

# Deno
deno run -A jsr:@nshiab/setup-data-project

# Node
npx @nshiab/setup-data-project

# Bun
bunx @nshiab/setup-data-project

To select a library without prompts, add --sda or --sda-core:

deno run -A jsr:@nshiab/setup-data-project --sda
npx @nshiab/setup-data-project --sda-core
bunx @nshiab/setup-data-project --sda

These flags still create the usual project files and documentation, preserve existing package versions, and cannot be combined. Without a flag, library selection is interactive. Use --help for usage.

  • Creates a standardized folder structure.
  • Ensures necessary files like .env, .gitignore, and README.md exist.
  • Lets you choose between simple-data-analysis-core, the full simple-data-analysis package, and journalism libraries.
  • Downloads version-matched library documentation for LLM use and links it from AGENTS.md.
  • Updates project configuration (e.g., deno.json or package.json) with relevant tasks.

The library is maintained by Nael Shiab, computational journalist and senior data producer for CBC News.

About

Quickly kick off your data project using the simple-data-analysis and journalism libraries.

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages