Development Data¶
The canonical development plan is data/tasks.yaml. It describes a fictional
project to build a jet airplane at a layperson’s level. All names, account
references, people, budgets, dates, and work item identifiers are invented.
Use this fixture when developing features or demonstrating output; do not copy
private plan content into tests or documentation.
The fixture covers:
Plan metadata, configured fiscal years, execution narratives, linked and unlinked activities, milestone definitions, and deliverables.
Every task status, priority, risk type, and risk level, with optional metadata and the supported inline Markdown subset.
Task defaults, completed-task shortcuts, funding-driven ongoing work with gaps, unfunded ongoing tasks, and a minimal planning placeholder.
Multipart inheritance, replacement and clearing, sibling and parent dependency references, authoritative parent budgets, and part-level funding overrides.
Work items and merge requests with labels, descriptions, assignees, open/closed status, and optional values omitted or explicitly cleared.
data/composite.yaml loads the same canonical plan with a whole-file
!include. Existing examples and focused tests cover alternative Python/YAML
forms, nested includes, and invalid inputs. Mutually exclusive alternatives,
such as fiscal-year ranges and explicit lists, cannot all appear in one valid
plan. See Plan Schema and Composite YAML Plans for those alternatives.
From the repository root:
export TUXFAN_PLANNER_DATA_DIRECTORY="$PWD/data"
planner validate tasks.yaml
planner list tasks tasks.yaml label
planner list workitems tasks.yaml status assignees
planner composite composite.yaml /tmp/airplane-expanded.yaml
# Planner initializes the default user configuration automatically on first use.
planner export tasks.yaml /tmp/airplane.docx
planner export-gantt tasks.yaml /tmp/airplane.pptx
An explicit filename selects among files in the directory; setting the directory
alone does not select a default plan. Optionally set
TUXFAN_PLANNER_DATA_FILE=tasks.yaml to omit filenames in later commands.
Regression tests load the canonical fixture, check schema/behavior coverage, verify the composite wrapper, and exercise field selection and each export format. Keep the fixture fictional when adding coverage for future features.