elspais 0.9.1__py3-none-any.whl

elspais-0.9.1.dist-info/METADATA

@@ -0,0 +1,393 @@
+Metadata-Version: 2.1
+Name: elspais
+Version: 0.9.1
+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: 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
+Keywords: documentation,requirements,specifications,traceability,validation
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Provides-Extra: binary
+Requires-Dist: pyinstaller>=6.0; extra == 'binary'
+Provides-Extra: dev
+Requires-Dist: black>=23.0; extra == 'dev'
+Requires-Dist: mypy>=1.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0; extra == 'dev'
+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'
+Description-Content-Type: text/markdown
+
+# elspais
+
+> "L-Space is the ultimate library, connecting all libraries everywhere through the sheer weight of accumulated knowledge."
+> — Terry Pratchett
+
+**elspais** is a requirements validation and traceability tool that helps teams manage formal requirements across single or multiple repositories. It supports configurable ID patterns, validation rules, and generates traceability matrices.
+
+## Features
+
+- **Zero Dependencies**: Core CLI uses only Python 3.9+ standard library
+- **Configurable ID Patterns**: Support for `REQ-p00001`, `PRD-00001`, `PROJ-123`, named requirements, and custom formats
+- **Validation Rules**: Enforce requirement hierarchies (PRD → OPS → DEV) with configurable constraints
+- **Multi-Repository**: Link requirements across core and associated repositories
+- **Traceability Matrices**: Generate Markdown, HTML, or CSV output
+- **Hash-Based Change Detection**: Track requirement changes with SHA-256 hashes
+- **Content Rules**: Define semantic validation guidelines for AI agents
+- **MCP Server**: Integrate with AI assistants via Model Context Protocol
+
+## Installation
+
+```bash
+pip install elspais
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/anspar/elspais.git
+cd elspais
+pip install -e .
+```
+
+## Quick Start
+
+### Initialize a Repository
+
+```bash
+# Create .elspais.toml with default configuration
+elspais init
+
+# Or specify repository type
+elspais init --type core              # Core repository
+elspais init --type associated --associated-prefix CAL  # Associated repo
+```
+
+### Validate Requirements
+
+```bash
+# Validate all requirements in spec/ directory
+elspais validate
+
+# Verbose output
+elspais validate -v
+
+# Validate with auto-fix for fixable issues
+elspais validate --fix
+```
+
+### Generate Traceability Matrix
+
+```bash
+# Generate both Markdown and HTML
+elspais trace
+
+# Generate specific format
+elspais trace --format html
+elspais trace --format csv
+
+# Custom output location
+elspais trace --output docs/traceability.html
+```
+
+### Manage Requirement Hashes
+
+```bash
+# Verify all hashes match content
+elspais hash verify
+
+# Update all hashes
+elspais hash update
+
+# Update specific requirement
+elspais hash update REQ-d00027
+```
+
+### Analyze Requirements
+
+```bash
+# Show requirement hierarchy tree
+elspais analyze hierarchy
+
+# Find orphaned requirements
+elspais analyze orphans
+
+# Implementation coverage report
+elspais analyze coverage
+```
+
+## Configuration
+
+Create `.elspais.toml` in your repository root:
+
+```toml
+[project]
+name = "my-project"
+type = "core"  # "core" | "associated"
+
+[directories]
+spec = "spec"
+docs = "docs"
+code = ["src", "apps", "packages"]
+
+[patterns]
+id_template = "{prefix}-{type}{id}"
+prefix = "REQ"
+
+[patterns.types]
+prd = { id = "p", name = "Product Requirement", level = 1 }
+ops = { id = "o", name = "Operations Requirement", level = 2 }
+dev = { id = "d", name = "Development Requirement", level = 3 }
+
+[patterns.id_format]
+style = "numeric"
+digits = 5
+leading_zeros = true
+
+[rules.hierarchy]
+allowed_implements = [
+    "dev -> ops, prd",
+    "ops -> prd",
+    "prd -> prd",
+]
+allow_circular = false
+allow_orphans = false
+
+[rules.format]
+require_hash = true
+require_assertions = true
+allowed_statuses = ["Active", "Draft", "Deprecated", "Superseded"]
+```
+
+See [docs/configuration.md](docs/configuration.md) for full reference.
+
+## Requirement Format
+
+elspais expects requirements in Markdown format:
+
+```markdown
+### REQ-d00001: Requirement Title
+
+**Level**: Dev | **Implements**: p00001 | **Status**: Active
+
+The system SHALL provide user authentication.
+
+**Rationale**: Security requires identity verification.
+
+**Acceptance Criteria**:
+- Users can log in with email/password
+- Session expires after 30 minutes of inactivity
+
+*End* *Requirement Title* | **Hash**: a1b2c3d4
+---
+```
+
+## ID Pattern Examples
+
+elspais supports multiple ID formats:
+
+| Pattern | Example | Configuration |
+|---------|---------|---------------|
+| HHT Default | `REQ-p00001` | `id_template = "{prefix}-{type}{id}"` |
+| Type-Prefix | `PRD-00001` | `id_template = "{type}-{id}"` |
+| Jira-Like | `PROJ-123` | `id_template = "{prefix}-{id}"` |
+| Named | `REQ-UserAuth` | `style = "named"` |
+| Associated | `REQ-CAL-d00001` | `associated.enabled = true` |
+
+See [docs/patterns.md](docs/patterns.md) for details.
+
+## Multi-Repository Support
+
+For associated repositories that reference a core repository:
+
+```toml
+[project]
+type = "associated"
+
+[associated]
+prefix = "CAL"
+
+[core]
+path = "../core-repo"
+```
+
+Validate with core linking:
+
+```bash
+elspais validate --core-repo ../core-repo
+```
+
+## Content Rules
+
+Content rules are markdown files that provide semantic validation guidance for AI agents authoring requirements:
+
+```bash
+# Configure content rules
+elspais config add rules.content_rules "spec/AI-AGENT.md"
+
+# List configured rules
+elspais rules list
+
+# View a specific rule
+elspais rules show AI-AGENT.md
+```
+
+Content rule files can include YAML frontmatter for metadata:
+
+```markdown
+---
+title: AI Agent Guidelines
+type: guidance
+applies_to: [requirements, assertions]
+---
+
+# AI Agent Guidelines
+
+- Use SHALL for normative statements
+- One assertion per obligation
+- No duplication across levels
+```
+
+## MCP Server (AI Integration)
+
+elspais includes an MCP (Model Context Protocol) server for AI assistant integration:
+
+```bash
+# Install with MCP support
+pip install elspais[mcp]
+
+# Start MCP server
+elspais mcp serve
+```
+
+Configure in Claude Desktop (`claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "elspais": {
+      "command": "elspais",
+      "args": ["mcp", "serve"],
+      "cwd": "/path/to/your/project"
+    }
+  }
+}
+```
+
+### MCP Resources
+
+| Resource | Description |
+|----------|-------------|
+| `requirements://all` | List all requirements |
+| `requirements://{id}` | Get requirement details |
+| `requirements://level/{level}` | Filter by PRD/OPS/DEV |
+| `content-rules://list` | List content rules |
+| `content-rules://{file}` | Get content rule content |
+| `config://current` | Current configuration |
+
+### MCP Tools
+
+| Tool | Description |
+|------|-------------|
+| `validate` | Run validation rules |
+| `parse_requirement` | Parse requirement text |
+| `search` | Search requirements |
+| `get_requirement` | Get requirement details |
+| `analyze` | Analyze hierarchy/orphans/coverage |
+
+## CLI Reference
+
+```
+elspais [OPTIONS] COMMAND [ARGS]
+
+Options:
+  --config PATH    Path to config file
+  --spec-dir PATH  Override spec directory
+  -v, --verbose    Verbose output
+  -q, --quiet      Suppress non-error output
+  --version        Show version
+  --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
+```
+
+## Development
+
+```bash
+# Clone and install in development mode
+git clone https://github.com/anspar/elspais.git
+cd elspais
+pip install -e ".[dev]"
+
+# Run tests
+pytest
+
+# Run with coverage
+pytest --cov=elspais
+
+# Type checking
+mypy src/elspais
+
+# Linting
+ruff check src/elspais
+black --check src/elspais
+```
+
+## Version Pinning
+
+For reproducible builds, pin the version in your project:
+
+```bash
+# .github/versions.env
+ELSPAIS_VERSION=0.1.0
+```
+
+```yaml
+# GitHub Actions
+- name: Install elspais
+  run: pip install elspais==${{ env.ELSPAIS_VERSION }}
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.
+
+## Contributing
+
+Contributions welcome! Please read the contributing guidelines before submitting PRs.
+
+## Links
+
+- [Documentation](https://github.com/anspar/elspais#readme)
+- [Issue Tracker](https://github.com/anspar/elspais/issues)
+- [Changelog](CHANGELOG.md)

elspais-0.9.1.dist-info/RECORD

@@ -0,0 +1,38 @@
+elspais/__init__.py,sha256=grQHU0RmRQChHUEb_cH_OuGmxADj5fDSNNayhXEQco4,1014
+elspais/__main__.py,sha256=rCMaObqJeT_6dhyfND7S4dh_lv30j7Ww3Z7992YYwaE,130
+elspais/cli.py,sha256=yJ8Bs_LfDA9hFvlowYgKOQGx9EoM5-9M2bAphYhrSHc,14098
+elspais/commands/__init__.py,sha256=jS7ry2ez7xri-fUlYUw9fGKJi5yTHtVN4PU8voHjgLI,155
+elspais/commands/analyze.py,sha256=5hE6YRL8AoAz2ukkR1rj6aiD2TNJi63UHYVJXmKoOUs,7135
+elspais/commands/config_cmd.py,sha256=KnH7vISH4041rqQrFftgffYLIujmIllZ_NCl5hIvCnE,13943
+elspais/commands/edit.py,sha256=Ey42VCAsV2G1WzCZ3qy1IAoG88zeba3O0iZjiodJZZA,16054
+elspais/commands/hash_cmd.py,sha256=pPKvhS99Nb-AEO5JrLUJQNQbXkfCJ0vVQE_L8PZW5NQ,5686
+elspais/commands/index.py,sha256=_jPGt_LnGI6gGJLonzOoM978YpTj14GWDCCemtSIah4,5283
+elspais/commands/init.py,sha256=y2vxR5pvd0gmONJYjX3GtGbMfmJU11k_zRKWCm7O6Qo,3870
+elspais/commands/rules_cmd.py,sha256=b2d0l-rn-WTd6ULJWsjAebBTcKv_yndO7pVNc29QEoo,3415
+elspais/commands/trace.py,sha256=xXpXD_ZDsr2B0YA342V4RJpV0zeRrq_l-gxwvO8NKHo,7651
+elspais/commands/validate.py,sha256=JItxCp9LjfJ-jD11C08NcnF37JFcfNacIYJCP3SV-2M,13083
+elspais/config/__init__.py,sha256=NkQEonHWWiXXCDrfehOCrsEYSuhj75KYj8oBQ7FuS4c,292
+elspais/config/defaults.py,sha256=6GddebKwrDAiTp0tGzkNSEuGM_HeA846o8CQPYS4yz8,5177
+elspais/config/loader.py,sha256=MnG_j2W1pOSRTTUHAOvu5xcJUAzDFNPvRjloFXpM15w,13827
+elspais/core/__init__.py,sha256=OTQ1TOf7iLN4czmlkrV5tiaxpAat0VcrWpxYbfonAys,576
+elspais/core/content_rules.py,sha256=4UoA_SUJK5R2MG9NE0Z8sNzMVPq3beEJGKEtX_NAeTk,4515
+elspais/core/hasher.py,sha256=X3Ry_M6zgs2pZPZ3UFItlvM0mRW6aPS0SKPhCYeaFUE,4259
+elspais/core/models.py,sha256=G08Yg9_69SSrdfGCgZJmya6DESiCijS2Y228q32m0l8,9558
+elspais/core/parser.py,sha256=LlureFW9dbpf26VsSF8yP7IvHcZC4zaJ_YPWgqx9sdc,22140
+elspais/core/patterns.py,sha256=wEkzIjBRDDFyR3LZ-Lbm0a2IaU6Pdi80a9UUqb_S_aQ,13082
+elspais/core/rules.py,sha256=WIn41JupkZannGgEfhqK__aomsJVU9aqpq__s2ZpZgU,19036
+elspais/mcp/__init__.py,sha256=5yYWJpYkRu8AyJHUkbIP1HVngdyGEygzonJjdypAKb0,1143
+elspais/mcp/__main__.py,sha256=oqpwTiE14vr5AGnP0MxRzILx_hYqonUMMK96dX-EXVw,134
+elspais/mcp/context.py,sha256=MmYsDFA6nEVmgRffCQlqJMQjI0joQQJh1tFFPEeUeCA,5538
+elspais/mcp/serializers.py,sha256=FuSJT_Qg5BTQEwdER0G7ES2IJYZw7mDqyQqQIZ6_3FA,2832
+elspais/mcp/server.py,sha256=tgmeodGIqzz3vvGunDI6NhY0avQKn0F0yOiF7sbjJ-I,10416
+elspais/testing/__init__.py,sha256=hJB3V28HoeZUnIexi2mkaBwo0bQ7uSxBs-IZmcmpFtQ,879
+elspais/testing/config.py,sha256=PQkrnuk_p8pObc-Nio3s3mIKLO4AfB-2eiwXruXTw0Y,1620
+elspais/testing/mapper.py,sha256=EGund_KgeYbAnWRRcnuVs0xCzlf7EvJ-qiluSmvRIso,5649
+elspais/testing/result_parser.py,sha256=u-TI5oytCqxz769AyU7WF9mOOULSzZAArvBg6JXwG1Q,9280
+elspais/testing/scanner.py,sha256=PEn0qJCE2eX2SCru3Cc-v18mf81q7BNkPYE-MZ3m8CM,7037
+elspais-0.9.1.dist-info/METADATA,sha256=3AtcIz9g0uMkL_txPwM638E5NBPSWA-jujYGwNahIAU,9682
+elspais-0.9.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+elspais-0.9.1.dist-info/entry_points.txt,sha256=yWZZEfn2fBSKSzGoS-fMQ9YoTkyeu6-i7Oht6NsdKpk,45
+elspais-0.9.1.dist-info/licenses/LICENSE,sha256=x_dNMsy_askp2MmKXZFL2bKW_tDiJHcRTyAg0TY1RMI,1063
+elspais-0.9.1.dist-info/RECORD,,

elspais-0.9.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

elspais-0.9.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+elspais = elspais.cli:main

elspais-0.9.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Anspar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.