fushinryu-model

fushinryu-model is a Python library providing the domain entities for the Fūshinryū (風心流) development projects management methodology.

It models the core requirement artefacts — scopes, user stories, acceptance criteria, and validation records — as immutable, mergeable Pydantic models.

Key features

• Structured requirements — Scope, UserStory, and AcceptanceCriterion form a clear hierarchy that maps directly to standard agile practices.
• Immutable validation records — ManualValidation and AutomatedValidation are frozen models; once recorded, evidence cannot be silently mutated.
• Merge semantics — every entity supports controlled merging where child values override parent values, enabling scope inheritance without data loss.
• DAG scope hierarchy — Scope instances can declare ordered parent scopes and collapse() the full ancestry into a single flat scope.
• Rule categories — Category, Commandment, and Suggestion model the hatto (法度): scoped policy rule sets that merge hierarchically by tree position.
• Pydantic v2 — full static typing, field validators, and discriminated unions throughout.

Navigation

• Getting Started — installation and a minimal working example.
• Domain Model — overview of entities and their relationships.
• Merging — how merge semantics work across the hierarchy.
• Scope Hierarchy — DAG parents and the collapse() algorithm.
• Reference — full API documentation.
• Rule Categories Reference — Category, Ruleset, Commandment, Suggestion.