cliqa 0.1.1__tar.gz

cliqa-0.1.1/.github/workflows/lint.yml

@@ -0,0 +1,29 @@
+name: Lint
+
+on:
+  push:
+  pull_request:
+  workflow_call:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install dependencies
+        run: uv sync --all-groups
+
+      - name: Run pre-commit
+        uses: pre-commit/action@v3.0.1

cliqa-0.1.1/.github/workflows/publish.yml

@@ -0,0 +1,63 @@
+name: Publish to PyPI
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+    secrets: inherit
+
+  lint:
+    uses: ./.github/workflows/lint.yml
+
+  publish:
+    needs: [test, lint]
+    if: "!contains(github.event.head_commit.message, 'Bump version')"
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install bump-my-version
+        run: uv tool install bump-my-version
+
+      - name: Configure git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Bump version
+        run: uv tool run bump-my-version bump patch
+
+      - name: Get version
+        id: version
+        run: echo "version=$(uv tool run bump-my-version show current_version)" >> $GITHUB_OUTPUT
+
+      - name: Commit and tag
+        run: |
+          git add pyproject.toml
+          git commit -m "Bump version to ${{ steps.version.outputs.version }}"
+          git tag "v${{ steps.version.outputs.version }}"
+          git push origin main --tags
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

cliqa-0.1.1/.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: Test
+
+on:
+  push:
+  pull_request:
+  workflow_call:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --extra test
+
+      - name: Run tests
+        run: uv run pytest
+        env:
+          ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
+
+      - name: Upload coverage
+        uses: codecov/codecov-action@v4
+        if: matrix.python-version == '3.13'
+        with:
+          file: ./htmlcov/index.html
+          fail_ci_if_error: false

cliqa-0.1.1/.gitignore

@@ -0,0 +1,48 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+.venv/
+venv/
+ENV/
+env/
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# Local settings
+.claude/
+
+# OS
+.DS_Store
+Thumbs.db

cliqa-0.1.1/.pre-commit-config.yaml

@@ -0,0 +1,88 @@
+default_language_version:
+  python: python313
+
+default_stages: [pre-commit]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+        args: [--markdown-linebreak-ext=md]
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      - id: check-yaml
+        args: [--unsafe]
+      - id: check-json
+      - id: check-toml
+      - id: check-xml
+      - id: check-merge-conflict
+      - id: check-case-conflict
+      - id: check-symlinks
+      - id: destroyed-symlinks
+      - id: check-ast
+      - id: check-docstring-first
+      - id: debug-statements
+      - id: name-tests-test
+        args: [--pytest-test-first]
+        exclude: ^tests/((__init__|conftest)\.py|.*/_mock_packages/.*|.*/pytest_.*_mock\.py)$
+      - id: detect-private-key
+      - id: check-added-large-files
+        args: [--maxkb=1000]
+  - repo: local
+    hooks:
+      - id: ruff-format
+        name: ruff-format
+        entry: uv run ruff format
+        language: system
+        types_or: [python, pyi]
+        require_serial: true
+      - id: ruff
+        name: ruff
+        entry: uv run ruff check --fix --exit-non-zero-on-fix
+        language: system
+        types_or: [python, pyi]
+        require_serial: true
+  - repo: local
+    hooks:
+      - id: basedpyright
+        name: basedpyright
+        entry: uv run basedpyright
+        language: system
+        types: [python]
+        pass_filenames: false
+        require_serial: true
+  - repo: local
+    hooks:
+      - id: vulture
+        name: vulture
+        entry: uv run vulture
+        language: system
+        types: [python]
+        pass_filenames: false
+        require_serial: true
+  - repo: local
+    hooks:
+      - id: bandit
+        name: bandit
+        entry: uv run bandit -c pyproject.toml -r src/clint/
+        language: system
+        types: [python]
+        pass_filenames: false
+        require_serial: true
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.43.0
+    hooks:
+      - id: markdownlint
+        args: [--fix, --disable, MD013, MD024, MD033, MD040, MD041, --]
+  - repo: https://github.com/commitizen-tools/commitizen
+    rev: v4.1.0
+    hooks:
+      - id: commitizen
+        stages: [commit-msg]
+  - repo: https://github.com/benomahony/nasa-lsp
+    rev: v0.1.6
+    hooks:
+      - id: nasa-lsp
+        exclude: ^tests/

cliqa-0.1.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ben O'Mahony
+
+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.

cliqa-0.1.1/PKG-INFO

@@ -0,0 +1,88 @@
+Metadata-Version: 2.4
+Name: cliqa
+Version: 0.1.1
+Summary: Analyze CLI tools against clig.dev guidelines
+Project-URL: Homepage, https://github.com/benomahony/cliqa
+Project-URL: Repository, https://github.com/benomahony/cliqa
+Project-URL: Issues, https://github.com/benomahony/cliqa/issues
+Author-email: Ben O'Mahony <benomahony@users.noreply.github.com>
+License: MIT
+License-File: LICENSE
+Keywords: analysis,cli,clig,command-line,guidelines,linter
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.12
+Requires-Dist: pydantic-ai>=1.47.0
+Requires-Dist: rich>=14.2.0
+Requires-Dist: typer>=0.21.1
+Provides-Extra: test
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'test'
+Requires-Dist: pytest-cov>=4.1.0; extra == 'test'
+Requires-Dist: pytest>=8.0.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+# cliqa
+
+Analyze CLI tools against [clig.dev](https://clig.dev) guidelines.
+
+## Installation
+
+```bash
+uv tool install cliqa
+# or
+pip install cliqa
+```
+
+## Usage
+
+Analyze any CLI command:
+
+```bash
+clint analyze ls
+clint analyze git
+clint analyze your-cli-tool
+```
+
+Run specific checks:
+
+```bash
+clint check ls help
+clint check git version
+```
+
+List all available checks:
+
+```bash
+clint list-checks
+```
+
+## Features
+
+- **No mocking**: Real integration tests with actual CLI commands
+- **93% test coverage**: Comprehensive test suite
+- **NASA05 compliance**: Defensive assertions throughout
+- **clig.dev alignment**: Checks against modern CLI best practices
+
+## Development
+
+```bash
+# Install dependencies
+uv sync --extra test
+
+# Run tests
+uv run pytest
+
+# Run pre-commit checks
+pre-commit run --all-files
+```
+
+## License
+
+MIT

cliqa-0.1.1/README.md

@@ -0,0 +1,58 @@
+# cliqa
+
+Analyze CLI tools against [clig.dev](https://clig.dev) guidelines.
+
+## Installation
+
+```bash
+uv tool install cliqa
+# or
+pip install cliqa
+```
+
+## Usage
+
+Analyze any CLI command:
+
+```bash
+clint analyze ls
+clint analyze git
+clint analyze your-cli-tool
+```
+
+Run specific checks:
+
+```bash
+clint check ls help
+clint check git version
+```
+
+List all available checks:
+
+```bash
+clint list-checks
+```
+
+## Features
+
+- **No mocking**: Real integration tests with actual CLI commands
+- **93% test coverage**: Comprehensive test suite
+- **NASA05 compliance**: Defensive assertions throughout
+- **clig.dev alignment**: Checks against modern CLI best practices
+
+## Development
+
+```bash
+# Install dependencies
+uv sync --extra test
+
+# Run tests
+uv run pytest
+
+# Run pre-commit checks
+pre-commit run --all-files
+```
+
+## License
+
+MIT

cliqa-0.1.1/pyproject.toml

@@ -0,0 +1,114 @@
+[project]
+name = "cliqa"
+version = "0.1.1"
+description = "Analyze CLI tools against clig.dev guidelines"
+readme = "README.md"
+requires-python = ">=3.12"
+license = {text = "MIT"}
+authors = [
+    {name = "Ben O'Mahony", email = "benomahony@users.noreply.github.com"}
+]
+keywords = ["cli", "command-line", "linter", "guidelines", "clig", "analysis"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Quality Assurance",
+    "Topic :: Software Development :: Testing",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Environment :: Console",
+]
+dependencies = [
+    "pydantic-ai>=1.47.0",
+    "rich>=14.2.0",
+    "typer>=0.21.1",
+]
+
+[project.urls]
+Homepage = "https://github.com/benomahony/cliqa"
+Repository = "https://github.com/benomahony/cliqa"
+Issues = "https://github.com/benomahony/cliqa/issues"
+
+[project.optional-dependencies]
+test = [
+    "pytest>=8.0.0",
+    "pytest-cov>=4.1.0",
+    "pytest-asyncio>=0.23.0",
+]
+
+[project.scripts]
+clint = "clint.cli:app"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/clint"]
+
+[tool.basedpyright]
+include = ["src/clint"]
+pythonVersion = "3.12"
+typeCheckingMode = "standard"
+reportMissingTypeStubs = false
+reportUnknownParameterType = false
+reportUnknownArgumentType = false
+reportUnknownMemberType = false
+reportUnknownVariableType = false
+
+[tool.vulture]
+min_confidence = 80
+paths = ["src/clint"]
+ignore_names = ["app", "console*", "GUIDELINES_URL", "STANDARD_FLAGS", "CLI_ANALYZER_INSTRUCTIONS"]
+
+[tool.bandit]
+exclude_dirs = ["tests"]
+skips = ["B101", "B105", "B404", "B603"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+addopts = "--cov=src/clint --cov-report=term-missing --cov-report=html --cov-branch --cov-fail-under=90"
+
+[tool.coverage.run]
+branch = true
+source = ["src/clint"]
+omit = ["tests/*"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if __name__ == .__main__.:",
+    "if TYPE_CHECKING:",
+    "@abstractmethod",
+]
+
+[tool.bumpversion]
+current_version = "0.1.1"
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
+serialize = ["{major}.{minor}.{patch}"]
+search = "{current_version}"
+replace = "{new_version}"
+commit = false
+tag = false
+
+[[tool.bumpversion.files]]
+filename = "pyproject.toml"
+search = 'version = "{current_version}"'
+replace = 'version = "{new_version}"'
+
+[dependency-groups]
+dev = [
+    "bandit>=1.9.3",
+    "basedpyright>=1.37.2",
+    "dead>=2.1.0",
+    "nasa-lsp>=0.1.6",
+    "pre-commit>=4.0.0",
+    "ruff>=0.14.14",
+    "vulture>=2.14",
+]

cliqa-0.1.1/src/clint/__init__.py

@@ -0,0 +1,4 @@
+from .models import AnalysisReport, CheckResult, Severity
+from .cli import app
+
+__all__ = ["app", "AnalysisReport", "CheckResult", "Severity"]