How doorstop-dev/doorstop works
Doorstop manages textual requirements and other linkable items stored as YAML files in version control. The principal workflow is to create documents and items, link items across a document tree, validate traceability, and publish reports. CLI commands orchestrate core operations; a GUI and server provide additional interfaces. The graph reflects README statements and SOURCE INDEX references, but many implementation details—especially tree behavior and server routing—were not excerpted, so uncertain connections are omitted.
Main entry points: commands.py CLI commands · item.py Requirement items · publisher.py Publish orchestration · document.py Documents
Components 26
User interfaces
- CLI entry point
doorstop/cli/main.py - CLI commands
doorstop/cli/commands.py - Desktop GUI
doorstop/gui/application.py - GUI entry point
doorstop/gui/main.py - HTTP server
doorstop/server/main.py
Requirements model
- Document tree
doorstop/core/tree.py - Documents
doorstop/core/document.py - Requirement items
doorstop/core/item.py - YAML item files
- UIDs and levels
doorstop/core/types.py
Document operations
- Tree builder
doorstop/core/builder.py - Import and create
doorstop/core/importer.py - Item editor
doorstop/core/editor.py - Export documents
doorstop/core/exporter.py
Validation and publishing
- Item validation
doorstop/core/validators/item_validator.py - Reference finder
doorstop/core/reference_finder.py - YAML validation
doorstop/core/yaml_validator.py - Publish orchestration
doorstop/core/publisher.py - Publisher base
doorstop/core/publishers/base.py - HTML publisher
doorstop/core/publishers/html.py - Markdown publisher
doorstop/core/publishers/markdown.py - LaTeX publisher
doorstop/core/publishers/latex.py - Text publisher
doorstop/core/publishers/text.py - Publish templates
doorstop/core/template.py
External integration
- Version control
doorstop/core/vcs/__init__.py
Other components
- User
Connections 30
- User → CLI entry point: runs commands
README.md - User → GUI entry point: opens GUI
- CLI entry point → CLI commands: dispatches to
doorstop/cli/main.py - CLI commands → Tree builder: builds tree
doorstop/cli/commands.py - Tree builder → Document tree: constructs
doorstop/core/builder.py - Tree builder → Version control: uses
doorstop/core/builder.py - Document tree → Documents: contains
- Documents → Requirement items: manages
doorstop/core/document.py - Requirement items → YAML item files: reads and writes
doorstop/core/item.py - Requirement items → UIDs and levels: uses identifiers
doorstop/core/item.py - CLI commands → Import and create: creates and imports
doorstop/cli/commands.py - Import and create → Documents: updates documents
doorstop/core/importer.py - Import and create → Requirement items: creates items
doorstop/core/importer.py - CLI commands → Item editor: opens editor
doorstop/cli/commands.py - CLI commands → Export documents: exports data
doorstop/cli/commands.py - CLI commands → Publish orchestration: publishes reports
doorstop/cli/commands.py - Publish orchestration → HTML publisher: selects format
doorstop/core/publisher.py - Publish orchestration → LaTeX publisher: selects format
doorstop/core/publisher.py - Publish orchestration → Markdown publisher: selects format
doorstop/core/publisher.py - Publish orchestration → Text publisher: selects format
doorstop/core/publisher.py - HTML publisher → Publisher base: extends
doorstop/core/publishers/html.py - Markdown publisher → Publisher base: extends
doorstop/core/publishers/markdown.py - LaTeX publisher → Publisher base: extends
doorstop/core/publishers/latex.py - Publisher base → Publish templates: uses templates
doorstop/core/publishers/base.py - Requirement items → YAML validation: validates YAML
doorstop/core/item.py - Requirement items → Reference finder: finds references
doorstop/core/item.py - Documents → Item validation: validates items
doorstop/core/document.py - GUI entry point → Desktop GUI: starts interface
doorstop/gui/main.py - Desktop GUI → Tree builder: loads project tree
doorstop/gui/application.py - HTTP server → HTML publisher: serves published HTML
doorstop/server/main.py