BulletJournal
BulletJournal is a notebook orchestration platform for reproducible data science. It layers explicit artifact passing, persistent graph state, stale detection, checkpoints, and managed execution on top of Marimo notebooks.
For multi-project orchestration with separated environments through Docker containers, see BulletJournal-Controller.
Requirements
- Python 3.11+
- A dedicated environment is recommended (
uvorvenv)
Quickstart
pip install bulletjournal-editor
bulletjournal init testproject
bulletjournal init /project --project-id study-a --skip-environment
bulletjournal start testproject --open
If you are already inside a project root, running bulletjournal with no subcommand starts the app.
Common commands
bulletjournal init testproject
bulletjournal init testproject --project-id custom-id
bulletjournal init /project --project-id study-a --skip-environment
bulletjournal start .
bulletjournal dev . --open
bulletjournal doctor .
bulletjournal validate-templates
bulletjournal rebuild-state .
bulletjournal mark-environment-changed . --reason "dependencies updated"
bulletjournal export . testproject.zip
bulletjournal import testproject.zip restored-study
Project layout
project_root/
├─ graph/
│ ├─ meta.json
│ ├─ nodes.json
│ ├─ edges.json
│ └─ layout.json
├─ notebooks/
├─ objects/
├─ dashboards/
├─ metadata/
│ ├─ project.json
│ └─ state.db
├─ checkpoints/
├─ temp/
│ ├─ uploads/
│ ├─ execution_logs/
│ └─ worker/
├─ pyproject.toml
└─ uv.lock
BulletJournal owns the project layout and schema files under graph/, metadata/, objects/, dashboards/, checkpoints/, and temp/.
pyproject.toml and uv.lock define the project environment, but they can be managed externally. Use bulletjournal init ... --skip-environment when another controller is responsible for environment definition and install orchestration.
bulletjournal init is safe to rerun. It leaves valid existing layout files in place, recreates missing required directories and runtime directories, fails on unsupported schema versions, and never overwrites existing pyproject.toml or uv.lock when --skip-environment is used.
Docs
docs/EXECUTION_PLAN.mddocs/ARCHITECTURE.mddocs/PROJECT_FORMAT.mddocs/NOTEBOOK_AUTHORING.mddocs/API.mddocs/TEMPLATES.mddocs/OPERATIONS.mddocs/ARTIFACT_LIFECYCLE.mddocs/TROUBLESHOOTING.mddocs/MCP.md
Testing
python3 -m venv .venv
source .venv/bin/activate
pip install -e ".[dev]"
PYTHONPATH=src python -m pytest
The default pytest configuration runs four workers with a fixed randomized order
(--randomly-seed=42). Override these defaults with additional pytest options
when diagnosing a failure, for example -n 0 for serial execution.
Pre-commit
ruff.toml is consumed by ruff automatically from the repo root. To enable the git hook:
pre-commit install
1 maintainer
Metadata
1 maintainer
Release files for bulletjournal-editor 2.3.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| bulletjournal_editor-2.3.4.tar.gz | 925.4 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bulletjournal_editor-2.3.4-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.9 MB
Release files / bulletjournal_editor-2.3.4.tar.gz
| Download URL | bulletjournal_editor-2.3.4.tar.gz |
|---|---|
| Size | 925.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
57fd79f24f83771bbedcb884e710393058d6a4b97b44cd6a353a9e0af92bf063
|
|
BLAKE2b-256 checksum How to use checksums |
2034d53e4df50ad7f233f27d71caa606159fcbffbf06e79a9fa8121663a8d448
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logRelease files / bulletjournal_editor-2.3.4-py3-none-any.whl
| Download URL | bulletjournal_editor-2.3.4-py3-none-any.whl |
|---|---|
| Size | 974.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
472b533d8440124ca115d04e5943c6a970c0b8feb18eda3f96a5f1aa7348defb
|
|
BLAKE2b-256 checksum How to use checksums |
8cca774da3e4d53878a2539ef3e1ad2a43ef4c0f5f68e86fbc03c8b6cf8917bc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logSecurity for bulletjournal-editor 2.3.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for bulletjournal_editor-2.3.4.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
