Quick Start
A minimal tasks.yaml:
tasks:
- {id: design, title: Design, status: done}
- {id: build, title: Build, status: in_progress, depends_on: [design]}
- {id: ship, title: Ship, status: goal, depends_on: [build]}
Render it to a dependency-graph PNG from Python:
import scitex_todo as todo
tasks = todo.load_tasks("tasks.yaml")
mermaid_src = todo.build_mermaid(tasks)
engine = todo.render(mermaid_src, "tasks.png") # 'mmdc' or 'kroki'
…or from the shell:
# default store: project -> user -> bundled example (or $SCITEX_TODO_TASKS)
scitex-todo render-graph -o tasks.png
# inspect the generated mermaid without rendering
scitex-todo render-graph --print-mermaid
# list the resolved tasks (machine-readable with --json)
scitex-todo list-tasks --json
Task schema
Each task in the tasks: list:
Field |
Required |
Meaning |
|---|---|---|
|
yes |
unique id, referenced by |
|
yes |
short label |
|
yes |
|
|
no |
owning repo / area |
|
no |
ids this task depends on (arrow |
|
no |
ids this task inhibits ( |
|
no |
free-text annotation |
|
no |
integer rank (lower = higher); document order if absent |
|
no |
id of the task this nests under (drill-down view) |
Where your task data lives
scitex-todo ships only the mechanism — no task content. The store resolves
in this order (first existing wins):
an explicit
--taskspath$SCITEX_TODO_TASKSproject scope:
<git-root>/.scitex/todo/tasks.yamluser scope:
~/.scitex/todo/tasks.yaml(relocatable via$SCITEX_DIR)the bundled generic example