Specform

Specform is a lightweight CLI for initializing structured, reproducible analysis projects with a standardized notebook template and project layout.

It helps teams start with the same analytical scaffold every time — reducing setup friction and improving reproducibility.

Install

pip install specform

Quickstart

Initialize a new Specform project in the current directory:

specform init .

This will:

• create a standardized analysis notebook
• enforce a consistent starting structure
• provide a reproducible scaffold for downstream work

You can also initialize into a new directory:

specform init my_project

What Specform Does

Specform focuses on structured project initialization rather than heavy workflow orchestration.

Current features

• Reproducible notebook template generation
• Consistent project bootstrapping
• CLI-first workflow (specform init)

Design goals

• minimal surface area
• fast startup
• no runtime dependencies beyond the template

Example Workflow

mkdir study
cd study
specform init .

Open the generated notebook and begin analysis with a pre-defined structure.

Command Reference

specform init [path]

Initialize a Specform project.

Arguments

• path (optional): target directory
  • default: current directory

Versioning

Specform follows semantic versioning:

• 0.x — rapid iteration
• 1.0 — stable template contract

Development

Clone the repository and install in editable mode:

pip install -e .

Run the CLI locally:

specform init .

License

MIT