elspais 0.9.1__tar.gz → 0.11.0__tar.gz

elspais-0.11.0/CHANGELOG.md

@@ -0,0 +1,174 @@
+# Changelog
+
+All notable changes to elspais will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.11.0] - 2026-01-15
+
+### Added
+- **Cross-repo hierarchy support** for `reformat-with-claude` command
+  - Resolves parent requirements from associated/sponsor repositories
+  - New `--core-repo` flag to specify core repository path
+  - Builds complete hierarchy graph across repository boundaries
+
+### Changed
+- **Performance optimization** for reformat command: Uses validation to filter requirements before reformatting instead of processing all files
+- Reformat module now uses core modules directly for consistent behavior
+
+### Fixed
+- Hash update robustness improved with better error handling and INFO logging
+- `normalize_req_id()` now uses config-based `PatternValidator` for consistent ID normalization
+- Associated prefix case is now preserved in normalized requirement IDs
+
+## [0.10.0] - 2026-01-10
+
+### Added
+- **trace-view integration**: Enhanced traceability visualization with optional dependencies
+  - Interactive HTML generation with Jinja2 templates (`elspais[trace-view]`)
+  - Collaborative review server with Flask REST API (`elspais[trace-review]`)
+  - New CLI flags: `--view`, `--embed-content`, `--edit-mode`, `--review-mode`, `--server`, `--port`
+- **New `trace_view` package** (`src/elspais/trace_view/`)
+  - `TraceViewRequirement` adapter wrapping core `Requirement` model
+  - Coverage calculation and orphan detection
+  - Implementation file scanning
+  - Generators for HTML, Markdown, and CSV output
+- **Review system** for collaborative requirement feedback
+  - Comment threads with nested replies
+  - Review flags and status change requests
+  - Git branch management for review workflows
+  - JSON-based persistence in `.elspais/reviews/`
+- **AI-assisted requirement reformatting** with `reformat-with-claude` command
+  - Transforms legacy "Acceptance Criteria" format to assertion-based format
+  - Format detection and validation
+  - Line break normalization
+  - Claude CLI integration with structured JSON output
+- **New `reformat` module** (`src/elspais/reformat/`)
+  - `detect_format()`, `needs_reformatting()` - format analysis
+  - `reformat_requirement()`, `assemble_new_format()` - AI transformation
+  - `normalize_line_breaks()`, `fix_requirement_line_breaks()` - cleanup
+  - `RequirementNode`, `build_hierarchy()` - requirement traversal
+- New optional dependency extras in pyproject.toml:
+  - `elspais[trace-view]`: jinja2 for HTML generation
+  - `elspais[trace-review]`: flask, flask-cors for review server
+  - `elspais[all]`: all optional features
+- New documentation: `docs/trace-view.md` user guide
+- 18 new integration tests for trace-view features
+
+### Changed
+- `elspais trace` command now delegates to trace-view when enhanced features requested
+- CLAUDE.md updated with trace-view architecture documentation
+
+## [0.9.4] - 2026-01-08
+
+### Added
+- **Roadmap conflict entries**: When duplicate requirement IDs exist (e.g., same ID in spec/ and spec/roadmap/), both requirements are now visible in output
+  - Duplicate entries stored with `__conflict` suffix key (e.g., `REQ-p00001__conflict`)
+  - New `is_conflict` and `conflict_with` fields on Requirement model
+  - Conflict entries treated as orphaned (`implements=[]`) for clear visibility
+  - Warning generated for each duplicate (surfaced as `id.duplicate` rule)
+- **Sponsor/associated repository spec scanning**: New `--mode` flag and sponsor configuration support
+  - `elspais validate --mode core`: Scan only core spec directories
+  - `elspais validate --mode combined`: Include sponsor specs (default)
+  - New `sponsors` module with zero-dependency YAML parser
+  - Configuration via `.github/config/sponsors.yml` with local override support
+  - `traceability.include_associated` config option (default: true)
+- 29 new tests for conflict entries and sponsor scanning
+
+### Changed
+- Parser now keeps both requirements when duplicates found (instead of ignoring second)
+- JSON output includes conflict metadata for both original and conflict entries
+
+## [0.9.3] - 2026-01-05
+
+### Added
+- Git-based change detection with new `changed` command
+  - `elspais changed`: Show uncommitted changes to spec files
+  - `elspais changed --json`: JSON output for programmatic use
+  - `elspais changed --all`: Include all changed files, not just spec/
+  - `elspais changed --base-branch`: Compare vs different branch
+- New `src/elspais/core/git.py` module with functions:
+  - `get_git_changes()`: Main entry point for git change detection
+  - `get_modified_files()`: Detect modified/untracked files via git status
+  - `get_changed_vs_branch()`: Files changed vs main/master branch
+  - `detect_moved_requirements()`: Detect requirements moved between files
+- 23 new tests for git functionality
+
+## [0.9.2] - 2026-01-05
+
+### Added
+- `id.duplicate` rule documentation in `docs/rules.md`
+- Dynamic version detection using `importlib.metadata`
+
+### Changed
+- Enhanced ParseResult API documentation in CLAUDE.md to explain warning handling
+- Updated CLAUDE.md with git.py module description
+
+## [0.9.1] - 2026-01-03
+
+### Changed
+- Updated CLAUDE.md with complete architecture documentation
+- Added testing/, mcp/, and content_rules modules to CLAUDE.md
+- Added ParseResult API design pattern documentation
+- Added Workflow section with contribution guidelines
+- Updated Python version reference from 3.8+ to 3.9+
+
+## [0.9.0] - 2026-01-03
+
+### Added
+- Test mapping and coverage functionality (`elspais.testing` module)
+  - `TestScanner`: Scans test files for requirement references
+  - `ResultParser`: Parses JUnit XML and pytest JSON test results
+  - `TestMapper`: Orchestrates scanning and result mapping
+- Parser resilience with `ParseResult` API and warning system
+  - Parser now returns `ParseResult` containing both requirements and warnings
+  - Non-fatal issues generate warnings instead of failing parsing
+
+## [0.2.1] - 2025-12-28
+
+### Changed
+- Renamed "sponsor" to "associated" throughout the codebase
+  - Config: `[sponsor]` → `[associated]`, `[patterns.sponsor]` → `[patterns.associated]`
+  - CLI: `--sponsor-prefix` → `--associated-prefix`, `--type sponsor` → `--type associated`
+  - ID template: `{sponsor}` → `{associated}`
+- Made the tool generic by removing standards-specific references
+- Updated documentation to use neutral terminology
+
+## [0.2.0] - 2025-12-28
+
+### Added
+- Multi-directory spec support: `spec = ["spec", "spec/roadmap"]`
+- Generic `get_directories()` function for any config key
+- Recursive directory scanning for code directories
+- `get_code_directories()` convenience function with auto-recursion
+- `ignore` config for excluding directories (node_modules, .git, etc.)
+- Configurable `no_reference_values` for Implements field (-, null, none, N/A)
+- `parse_directories()` method for parsing multiple spec directories
+- `skip_files` config support across all commands
+
+### Fixed
+- Body extraction now matches hht-diary behavior (includes Rationale/Acceptance)
+- Hash calculation strips trailing whitespace for consistency
+- skip_files config now properly passed to parser in all commands
+
+## [0.1.0] - 2025-12-27
+
+### Added
+- Initial release of elspais requirements validation tools
+- Configurable requirement ID patterns (REQ-p00001, PRD-00001, PROJ-123, etc.)
+- Configurable validation rules with hierarchy enforcement
+- TOML-based per-repository configuration (.elspais.toml)
+- CLI commands: validate, trace, hash, index, analyze, init
+- Multi-repository support (core/associated model)
+- Traceability matrix generation (Markdown, HTML, CSV)
+- Hash-based change detection for requirements
+- Zero external dependencies (Python 3.8+ standard library only)
+- Core requirement parsing and validation
+- Pattern matching for multiple ID formats
+- Rule engine for hierarchy validation
+- Configuration system with sensible defaults
+- Test fixtures for multiple requirement formats
+- Comprehensive documentation

{elspais-0.9.1 → elspais-0.11.0}/PKG-INFO

@@ -1,15 +1,14 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: elspais
-Version: 0.9.1
+Version: 0.11.0
 Summary: Requirements validation and traceability tools - L-Space connects all libraries
-Home-page: https://github.com/anspar/elspais
-Author: Anspar
-Author-email: dev@anspar.io
-License: MIT
+Project-URL: Homepage, https://github.com/anspar/elspais
 Project-URL: Documentation, https://github.com/anspar/elspais#readme
 Project-URL: Repository, https://github.com/anspar/elspais
 Project-URL: Issues, https://github.com/anspar/elspais/issues
 Project-URL: Changelog, https://github.com/anspar/elspais/blob/main/CHANGELOG.md
+Author-email: Anspar <dev@anspar.io>
+License-File: LICENSE
 Keywords: documentation,requirements,specifications,traceability,validation
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
@@ -25,6 +24,11 @@ Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Software Development :: Quality Assurance
 Classifier: Typing :: Typed
 Requires-Python: >=3.9
+Provides-Extra: all
+Requires-Dist: flask-cors>=4.0; extra == 'all'
+Requires-Dist: flask>=2.0; extra == 'all'
+Requires-Dist: jinja2>=3.0; extra == 'all'
+Requires-Dist: mcp>=1.0; extra == 'all'
 Provides-Extra: binary
 Requires-Dist: pyinstaller>=6.0; extra == 'binary'
 Provides-Extra: dev
@@ -35,6 +39,12 @@ Requires-Dist: pytest>=7.0; extra == 'dev'
 Requires-Dist: ruff>=0.1.0; extra == 'dev'
 Provides-Extra: mcp
 Requires-Dist: mcp>=1.0; extra == 'mcp'
+Provides-Extra: trace-review
+Requires-Dist: flask-cors>=4.0; extra == 'trace-review'
+Requires-Dist: flask>=2.0; extra == 'trace-review'
+Requires-Dist: jinja2>=3.0; extra == 'trace-review'
+Provides-Extra: trace-view
+Requires-Dist: jinja2>=3.0; extra == 'trace-view'
 Description-Content-Type: text/markdown
 
 # elspais
@@ -57,18 +67,50 @@ Description-Content-Type: text/markdown
 
 ## Installation
 
+### For End Users
+
 ```bash
+# Recommended: Isolated installation with pipx
+pipx install elspais
+
+# Or standard pip installation
 pip install elspais
 ```
 
-Or install from source:
+### For Development
 
 ```bash
 git clone https://github.com/anspar/elspais.git
 cd elspais
-pip install -e .
+pip install -e ".[dev]"
+```
+
+### For Docker and CI/CD
+
+For faster installation in containerized environments, consider [uv](https://github.com/astral-sh/uv):
+
+```dockerfile
+# Example Dockerfile
+FROM python:3.11-slim
+
+# Copy uv binary
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
+
+# Install elspais (10-100x faster than pip)
+RUN uv pip install --system --no-cache elspais==0.9.3
 ```
 
+```yaml
+# Example GitHub Actions
+- name: Install uv
+  uses: astral-sh/setup-uv@v2
+
+- name: Install elspais
+  run: uv pip install --system elspais==0.9.3
+```
+
+**Note:** For regulated/medical software projects, always pin the exact version for reproducibility.
+
 ## Quick Start
 
 ### Initialize a Repository
@@ -185,22 +227,28 @@ See [docs/configuration.md](docs/configuration.md) for full reference.
 elspais expects requirements in Markdown format:
 
 ```markdown
-### REQ-d00001: Requirement Title
+# REQ-d00001: Requirement Title
+
+**Level**: Dev | **Status**: Active | **Implements**: REQ-p00001
 
-**Level**: Dev | **Implements**: p00001 | **Status**: Active
+## Assertions
 
-The system SHALL provide user authentication.
+A. The system SHALL provide user authentication via email/password.
+B. Sessions SHALL expire after 30 minutes of inactivity.
 
-**Rationale**: Security requires identity verification.
+## Rationale
 
-**Acceptance Criteria**:
-- Users can log in with email/password
-- Session expires after 30 minutes of inactivity
+Security requires identity verification.
 
 *End* *Requirement Title* | **Hash**: a1b2c3d4
 ---
 ```
 
+Key format elements:
+- **Assertions section**: Labeled A-Z, each using SHALL for normative statements
+- **One-way traceability**: Children reference parents via `Implements:`
+- **Hash footer**: SHA-256 hash for change detection
+
 ## ID Pattern Examples
 
 elspais supports multiple ID formats:
@@ -328,19 +376,23 @@ Options:
   --help           Show help
 
 Commands:
-  validate   Validate requirements format, links, hashes
-  trace      Generate traceability matrix
-  hash       Manage requirement hashes (verify, update)
-  index      Validate or regenerate INDEX.md
-  analyze    Analyze requirement hierarchy
-  edit       Edit requirements in-place (status, implements, move)
-  config     View and modify configuration
-  rules      View and manage content rules
-  mcp        MCP server commands (requires elspais[mcp])
-  version    Show version and check for updates
-  init       Create .elspais.toml configuration
+  validate              Validate requirements format, links, hashes
+  trace                 Generate traceability matrix
+  hash                  Manage requirement hashes (verify, update)
+  reformat-with-claude  Transform requirements using AI (Acceptance Criteria → Assertions)
+  changed               Detect git changes to spec files
+  analyze               Analyze requirement hierarchy
+  edit                  Edit requirements in-place (status, implements, move)
+  config                View and modify configuration
+  rules                 View and manage content rules
+  index                 Validate or regenerate INDEX.md
+  init                  Create .elspais.toml configuration
+  mcp                   MCP server commands (requires elspais[mcp])
+  version               Show version and check for updates
 ```
 
+See [docs/commands.md](docs/commands.md) for comprehensive command documentation.
+
 ## Development
 
 ```bash

{elspais-0.9.1 → elspais-0.11.0}/README.md

@@ -18,18 +18,50 @@
 
 ## Installation
 
+### For End Users
+
 ```bash
+# Recommended: Isolated installation with pipx
+pipx install elspais
+
+# Or standard pip installation
 pip install elspais
 ```
 
-Or install from source:
+### For Development
 
 ```bash
 git clone https://github.com/anspar/elspais.git
 cd elspais
-pip install -e .
+pip install -e ".[dev]"
+```
+
+### For Docker and CI/CD
+
+For faster installation in containerized environments, consider [uv](https://github.com/astral-sh/uv):
+
+```dockerfile
+# Example Dockerfile
+FROM python:3.11-slim
+
+# Copy uv binary
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /usr/local/bin/uv
+
+# Install elspais (10-100x faster than pip)
+RUN uv pip install --system --no-cache elspais==0.9.3
 ```
 
+```yaml
+# Example GitHub Actions
+- name: Install uv
+  uses: astral-sh/setup-uv@v2
+
+- name: Install elspais
+  run: uv pip install --system elspais==0.9.3
+```
+
+**Note:** For regulated/medical software projects, always pin the exact version for reproducibility.
+
 ## Quick Start
 
 ### Initialize a Repository
@@ -146,22 +178,28 @@ See [docs/configuration.md](docs/configuration.md) for full reference.
 elspais expects requirements in Markdown format:
 
 ```markdown
-### REQ-d00001: Requirement Title
+# REQ-d00001: Requirement Title
+
+**Level**: Dev | **Status**: Active | **Implements**: REQ-p00001
 
-**Level**: Dev | **Implements**: p00001 | **Status**: Active
+## Assertions
 
-The system SHALL provide user authentication.
+A. The system SHALL provide user authentication via email/password.
+B. Sessions SHALL expire after 30 minutes of inactivity.
 
-**Rationale**: Security requires identity verification.
+## Rationale
 
-**Acceptance Criteria**:
-- Users can log in with email/password
-- Session expires after 30 minutes of inactivity
+Security requires identity verification.
 
 *End* *Requirement Title* | **Hash**: a1b2c3d4
 ---
 ```
 
+Key format elements:
+- **Assertions section**: Labeled A-Z, each using SHALL for normative statements
+- **One-way traceability**: Children reference parents via `Implements:`
+- **Hash footer**: SHA-256 hash for change detection
+
 ## ID Pattern Examples
 
 elspais supports multiple ID formats:
@@ -289,19 +327,23 @@ Options:
   --help           Show help
 
 Commands:
-  validate   Validate requirements format, links, hashes
-  trace      Generate traceability matrix
-  hash       Manage requirement hashes (verify, update)
-  index      Validate or regenerate INDEX.md
-  analyze    Analyze requirement hierarchy
-  edit       Edit requirements in-place (status, implements, move)
-  config     View and modify configuration
-  rules      View and manage content rules
-  mcp        MCP server commands (requires elspais[mcp])
-  version    Show version and check for updates
-  init       Create .elspais.toml configuration
+  validate              Validate requirements format, links, hashes
+  trace                 Generate traceability matrix
+  hash                  Manage requirement hashes (verify, update)
+  reformat-with-claude  Transform requirements using AI (Acceptance Criteria → Assertions)
+  changed               Detect git changes to spec files
+  analyze               Analyze requirement hierarchy
+  edit                  Edit requirements in-place (status, implements, move)
+  config                View and modify configuration
+  rules                 View and manage content rules
+  index                 Validate or regenerate INDEX.md
+  init                  Create .elspais.toml configuration
+  mcp                   MCP server commands (requires elspais[mcp])
+  version               Show version and check for updates
 ```
 
+See [docs/commands.md](docs/commands.md) for comprehensive command documentation.
+
 ## Development
 
 ```bash