mustmatch 0.0.1__tar.gz

mustmatch-0.0.1/PKG-INFO

@@ -0,0 +1,235 @@
+Metadata-Version: 2.4
+Name: mustmatch
+Version: 0.0.1
+Summary: Validate CLI and Python projects
+Author-email: Ian Maurer <ian@genomoncology.com>
+License: MIT
+Project-URL: Homepage, https://github.com/botassembly/mustmatch
+Project-URL: Repository, https://github.com/botassembly/mustmatch
+Keywords: testing,documentation,cli,assertions
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Documentation
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: mistune>=3.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0; extra == "dev"
+Requires-Dist: ruff>=0.1.0; extra == "dev"
+
+# mustmatch
+
+**Assert CLI output. Test your documentation.**
+
+```bash
+# Verify command output
+echo "hello" | mustmatch "hello"
+
+# Test for substrings
+ls -la | mustmatch like "README"
+
+# JSON comparison (field order doesn't matter)
+echo '{"status":"ok","count":42}' | mustmatch like '{"status":"ok"}'
+
+# Regex patterns
+date +%Y-%m-%d | mustmatch '/^\d{4}-\d{2}-\d{2}$/'
+
+# Assert errors DON'T appear
+echo "success" | mustmatch not like "error"
+```
+
+## Install
+
+```
+pip install mustmatch
+```
+
+## Why mustmatch?
+
+Your documentation has examples. But do they work?
+
+```bash
+# This example in your README:
+echo "hello" | mustmatch "hello"
+
+# Will it work tomorrow? Next week? After refactoring?
+# With mustmatch, your docs are tests. If docs pass, examples work.
+```
+
+## Quick Start
+
+### 1. Pipe and Match
+
+```bash
+echo "hello" | mustmatch "hello"        # ✓ Exit 0
+echo "hello world" | mustmatch like "world"   # ✓ Contains
+echo "success" | mustmatch not like "error"   # ✓ Negation
+```
+
+### 2. Auto-Detection
+
+mustmatch figures out what you want:
+
+```bash
+# String comparison
+echo "hello" | mustmatch "hello"
+
+# Regex (from /slashes/)
+date +%Y-%m-%d | mustmatch '/^\d{4}-\d{2}-\d{2}$/'
+
+# JSON (from {braces})
+echo '{"a":1,"b":2}' | mustmatch '{"a":1,"b":2}'
+```
+
+### 3. JSON Intelligence
+
+```bash
+# Field order doesn't matter
+echo '{"b":2,"a":1}' | mustmatch '{"a":1,"b":2}'
+
+# Subset matching
+echo '{"status":"ok","count":42}' | mustmatch like '{"status":"ok"}'
+```
+
+## Comparison Modes
+
+### Exact Match
+
+```bash
+echo "hello" | mustmatch "hello"
+```
+
+### Contains (`like`)
+
+```bash
+echo "hello world" | mustmatch like "world"
+ls -la | mustmatch like "README"
+```
+
+### Negation (`not`)
+
+```bash
+echo "success" | mustmatch not "error"
+echo "success" | mustmatch not like "error"
+```
+
+### Regex (`/pattern/`)
+
+```bash
+date +%Y-%m-%d | mustmatch '/^\d{4}-\d{2}-\d{2}$/'
+echo "v1.2.3" | mustmatch '/^v\d+\.\d+\.\d+$/'
+```
+
+### JSON (semantic)
+
+```bash
+# Field order doesn't matter
+echo '{"b":2,"a":1}' | mustmatch '{"a":1,"b":2}'
+
+# Subset matching
+echo '{"status":"ok","count":42,"time":"2024-01-01"}' | \
+    mustmatch like '{"status":"ok"}'
+```
+
+## Text Normalization
+
+mustmatch automatically cleans output:
+
+```bash
+# ANSI codes stripped
+ls --color=always | mustmatch like "README"
+
+# Whitespace trimmed
+echo "  hello  " | mustmatch "hello"
+
+# Newlines normalized
+printf "hello\r\n" | mustmatch "hello"
+```
+
+## Exit Codes
+
+```bash
+echo "ok" | mustmatch "ok"              # Exit 0 (match)
+echo "ok" | mustmatch "fail" || echo "no match"   # Exit 1
+
+# Use in scripts
+if echo "ready" | mustmatch "ready"; then
+    echo "Proceeding..."
+fi
+```
+
+## Use Cases
+
+### Keep Documentation Up-to-Date
+
+Every example in your docs becomes a test. If the example breaks, CI fails.
+
+### DevOps Scripts
+
+Verify service health in deployment scripts.
+
+### API Testing
+
+Test JSON API responses with semantic comparison.
+
+## CLI Reference
+
+```
+Usage:
+    command | mustmatch [not] [like] EXPECTED
+
+Options:
+    -i, --ignore-case    Case-insensitive
+    -q, --quiet          Suppress output
+    --version            Show version
+    -h, --help           Show help
+
+Exit codes:
+    0    Match succeeded
+    1    Match failed
+    2    Invalid arguments
+```
+
+## Examples
+
+```bash
+# Exact match
+echo "hello" | mustmatch "hello"
+
+# Case insensitive
+echo "HELLO" | mustmatch -i "hello"
+
+# Contains
+echo "hello world" | mustmatch like "world"
+
+# Negation
+echo "success" | mustmatch not like "error"
+
+# Regex
+date +%Y-%m-%d | mustmatch '/^\d{4}-\d{2}-\d{2}$/'
+
+# JSON
+echo '{"a":1,"b":2}' | mustmatch '{"a":1,"b":2}'
+
+# JSON subset
+echo '{"status":"ok","count":42}' | mustmatch like '{"status":"ok"}'
+
+# Check help output
+mustmatch --help | mustmatch like "Usage:"
+
+# Verify version
+mustmatch --version | mustmatch like "mustmatch"
+```
+
+## License
+
+MIT

mustmatch-0.0.1/README.md

@@ -0,0 +1,207 @@
+# mustmatch
+
+**Assert CLI output. Test your documentation.**
+
+```bash
+# Verify command output
+echo "hello" | mustmatch "hello"
+
+# Test for substrings
+ls -la | mustmatch like "README"
+
+# JSON comparison (field order doesn't matter)
+echo '{"status":"ok","count":42}' | mustmatch like '{"status":"ok"}'
+
+# Regex patterns
+date +%Y-%m-%d | mustmatch '/^\d{4}-\d{2}-\d{2}$/'
+
+# Assert errors DON'T appear
+echo "success" | mustmatch not like "error"
+```
+
+## Install
+
+```
+pip install mustmatch
+```
+
+## Why mustmatch?
+
+Your documentation has examples. But do they work?
+
+```bash
+# This example in your README:
+echo "hello" | mustmatch "hello"
+
+# Will it work tomorrow? Next week? After refactoring?
+# With mustmatch, your docs are tests. If docs pass, examples work.
+```
+
+## Quick Start
+
+### 1. Pipe and Match
+
+```bash
+echo "hello" | mustmatch "hello"        # ✓ Exit 0
+echo "hello world" | mustmatch like "world"   # ✓ Contains
+echo "success" | mustmatch not like "error"   # ✓ Negation
+```
+
+### 2. Auto-Detection
+
+mustmatch figures out what you want:
+
+```bash
+# String comparison
+echo "hello" | mustmatch "hello"
+
+# Regex (from /slashes/)
+date +%Y-%m-%d | mustmatch '/^\d{4}-\d{2}-\d{2}$/'
+
+# JSON (from {braces})
+echo '{"a":1,"b":2}' | mustmatch '{"a":1,"b":2}'
+```
+
+### 3. JSON Intelligence
+
+```bash
+# Field order doesn't matter
+echo '{"b":2,"a":1}' | mustmatch '{"a":1,"b":2}'
+
+# Subset matching
+echo '{"status":"ok","count":42}' | mustmatch like '{"status":"ok"}'
+```
+
+## Comparison Modes
+
+### Exact Match
+
+```bash
+echo "hello" | mustmatch "hello"
+```
+
+### Contains (`like`)
+
+```bash
+echo "hello world" | mustmatch like "world"
+ls -la | mustmatch like "README"
+```
+
+### Negation (`not`)
+
+```bash
+echo "success" | mustmatch not "error"
+echo "success" | mustmatch not like "error"
+```
+
+### Regex (`/pattern/`)
+
+```bash
+date +%Y-%m-%d | mustmatch '/^\d{4}-\d{2}-\d{2}$/'
+echo "v1.2.3" | mustmatch '/^v\d+\.\d+\.\d+$/'
+```
+
+### JSON (semantic)
+
+```bash
+# Field order doesn't matter
+echo '{"b":2,"a":1}' | mustmatch '{"a":1,"b":2}'
+
+# Subset matching
+echo '{"status":"ok","count":42,"time":"2024-01-01"}' | \
+    mustmatch like '{"status":"ok"}'
+```
+
+## Text Normalization
+
+mustmatch automatically cleans output:
+
+```bash
+# ANSI codes stripped
+ls --color=always | mustmatch like "README"
+
+# Whitespace trimmed
+echo "  hello  " | mustmatch "hello"
+
+# Newlines normalized
+printf "hello\r\n" | mustmatch "hello"
+```
+
+## Exit Codes
+
+```bash
+echo "ok" | mustmatch "ok"              # Exit 0 (match)
+echo "ok" | mustmatch "fail" || echo "no match"   # Exit 1
+
+# Use in scripts
+if echo "ready" | mustmatch "ready"; then
+    echo "Proceeding..."
+fi
+```
+
+## Use Cases
+
+### Keep Documentation Up-to-Date
+
+Every example in your docs becomes a test. If the example breaks, CI fails.
+
+### DevOps Scripts
+
+Verify service health in deployment scripts.
+
+### API Testing
+
+Test JSON API responses with semantic comparison.
+
+## CLI Reference
+
+```
+Usage:
+    command | mustmatch [not] [like] EXPECTED
+
+Options:
+    -i, --ignore-case    Case-insensitive
+    -q, --quiet          Suppress output
+    --version            Show version
+    -h, --help           Show help
+
+Exit codes:
+    0    Match succeeded
+    1    Match failed
+    2    Invalid arguments
+```
+
+## Examples
+
+```bash
+# Exact match
+echo "hello" | mustmatch "hello"
+
+# Case insensitive
+echo "HELLO" | mustmatch -i "hello"
+
+# Contains
+echo "hello world" | mustmatch like "world"
+
+# Negation
+echo "success" | mustmatch not like "error"
+
+# Regex
+date +%Y-%m-%d | mustmatch '/^\d{4}-\d{2}-\d{2}$/'
+
+# JSON
+echo '{"a":1,"b":2}' | mustmatch '{"a":1,"b":2}'
+
+# JSON subset
+echo '{"status":"ok","count":42}' | mustmatch like '{"status":"ok"}'
+
+# Check help output
+mustmatch --help | mustmatch like "Usage:"
+
+# Verify version
+mustmatch --version | mustmatch like "mustmatch"
+```
+
+## License
+
+MIT

mustmatch-0.0.1/pyproject.toml

@@ -0,0 +1,83 @@
+[build-system]
+requires = ["setuptools>=68.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mustmatch"
+version = "0.0.1"
+description = "Validate CLI and Python projects"
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [
+    {name = "Ian Maurer", email = "ian@genomoncology.com"}
+]
+keywords = ["testing", "documentation", "cli", "assertions"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Documentation",
+]
+dependencies = [
+    "mistune>=3.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/botassembly/mustmatch"
+Repository = "https://github.com/botassembly/mustmatch"
+
+[project.scripts]
+mustmatch = "mustmatch.cli:cli"
+
+[project.entry-points."pytest11"]
+mustmatch = "mustmatch.pytest_plugin"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov>=4.0",
+    "ruff>=0.1.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+testpaths = ["docs"]
+pythonpath = ["src"]
+python_files = []
+python_classes = []
+python_functions = []
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "W"]
+
+[tool.coverage.run]
+source = ["src/mustmatch"]
+branch = true
+parallel = true
+omit = [
+    "src/mustmatch/__main__.py",
+    "src/mustmatch/version.py",
+    "src/mustmatch/pytest_plugin.py",
+    "src/mustmatch/cli.py",
+]
+
+[tool.coverage.report]
+fail_under = 45
+exclude_lines = [
+    "pragma: no cover",
+    "if __name__ == .__main__.:",
+]

mustmatch-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mustmatch-0.0.1/src/mustmatch/__init__.py

@@ -0,0 +1,13 @@
+"""
+mustmatch: CLI output assertion tool for documentation testing.
+
+Public API:
+    - CLI: `mustmatch` command (see cli.py)
+    - pytest plugin: auto-loaded via entry point (see pytest_plugin.py)
+
+All other functionality is internal.
+"""
+
+from .version import __version__
+
+__all__ = ["__version__"]

mustmatch-0.0.1/src/mustmatch/__main__.py

@@ -0,0 +1,6 @@
+"""Allow running as python -m mustmatch."""
+
+from mustmatch.cli import cli
+
+if __name__ == "__main__":
+    cli()