reuse-api 0.1.0__tar.gz

reuse_api-0.1.0/.github/workflows/deploy-pages.yml

@@ -0,0 +1,37 @@
+name: Deploy GitHub Pages
+
+on:
+  push:
+    branches:
+      - web
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "."
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

reuse_api-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,55 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        run: uv python install 3.11
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Build wheel and sdist
+        run: uv build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/reuse-api/
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_TOKEN }}

reuse_api-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

reuse_api-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11

reuse_api-0.1.0/PKG-INFO

@@ -0,0 +1,180 @@
+Metadata-Version: 2.4
+Name: reuse-api
+Version: 0.1.0
+Summary: OpenAPI AI Readiness Scorecard & Sandbox — score and simulate your APIs for agentic use
+Project-URL: Homepage, https://sheepseb.github.io/cli-jentic
+Project-URL: Repository, https://github.com/SheepSeb/cli-jentic
+Project-URL: Bug Tracker, https://github.com/SheepSeb/cli-jentic/issues
+Author: SheepSeb
+License: MIT
+Keywords: agentic,agents,ai,api,llm,mock-server,openapi,sandbox,scorecard
+Classifier: Development Status :: 3 - Alpha
+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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: flask>=3
+Requires-Dist: openapi-spec-validator>=0.7
+Requires-Dist: pydantic>=2
+Requires-Dist: pyyaml>=6
+Requires-Dist: requests>=2.31
+Requires-Dist: typer[all]>=0.9
+Description-Content-Type: text/markdown
+
+# api-scorecard
+
+A CLI tool that scores OpenAPI specs for AI-readiness across 6 dimensions — giving APIs a letter grade and actionable recommendations so they work well with AI agents and LLM tooling.
+
+## Installation
+
+```bash
+# With uv (recommended)
+uv pip install -e .
+
+# Or with pip
+pip install -e .
+```
+
+## Usage
+
+### Scorecard
+
+```bash
+# Score an OpenAPI spec
+api-scorecard score path/to/openapi.yaml
+
+# Output as JSON
+api-scorecard score path/to/openapi.yaml --json
+
+# Run against the built-in sample spec to see how scoring works
+api-scorecard demo
+api-scorecard demo --json
+```
+
+### Sandbox
+
+The sandbox spins up a local mock server from your spec and auto-probes every endpoint, reporting a **feasibility score** — how well the spec can actually be exercised by an agent.
+
+```bash
+# Start a persistent mock server (press Ctrl+C to stop)
+api-scorecard sandbox start path/to/openapi.yaml
+api-scorecard sandbox start path/to/openapi.yaml --port 9000
+
+# Probe all endpoints and get a report
+api-scorecard sandbox probe path/to/openapi.yaml
+api-scorecard sandbox probe path/to/openapi.yaml --json
+
+# Run against the built-in sample spec
+api-scorecard sandbox demo
+api-scorecard sandbox demo --json
+```
+
+The `probe` command:
+1. Starts an internal mock server
+2. Generates synthetic request payloads and path parameters from the spec's schemas
+3. Fires requests at every operation
+4. Reports per-endpoint status codes, response times, and any issues found
+5. Exits with code `2` if the feasibility score is below 50%
+
+### Exit codes
+
+| Code | Meaning |
+|------|---------|
+| `0` | Success / score ≥ threshold |
+| `1` | Error reading or parsing the spec |
+| `2` | Score below threshold (< 60 for scorecard, < 50% for sandbox) |
+
+## What gets scored
+
+Each spec is evaluated across 6 weighted dimensions:
+
+| Dimension | Weight | What it checks |
+|-----------|--------|----------------|
+| **Foundational Compliance** | 20% | OpenAPI version, `info` object, paths defined, spec validity |
+| **Developer Experience** | 15% | Operation IDs, summaries, request/response examples, parameter descriptions |
+| **AI-Readiness & Agent Experience** | 20% | Meaningful descriptions, error responses (4xx/5xx), response schemas, schema property descriptions |
+| **Agent Usability** | 20% | Semantic operation IDs, tag usage, parameter schemas, request body documentation |
+| **Security & Governance** | 15% | Security schemes defined, operations secured, auth documentation |
+| **AI Discoverability** | 10% | API-level description, tags defined, external docs |
+
+### Grading
+
+| Score | Grade |
+|-------|-------|
+| 90–100 | A |
+| 80–89 | B |
+| 70–79 | C |
+| 60–69 | D |
+| < 60 | F |
+
+## Example output
+
+```
+╭─ API AI Readiness Scorecard ──────────────────────────────────╮
+│  Task Manager API  v1.0.0                                      │
+│  sample_spec.yaml                                              │
+│                                                                │
+│  Overall Score: 42.3/100  Grade: F                             │
+╰────────────────────────────────────────────────────────────────╯
+
+╭──────────────────────────────────┬───────────┬───────┬──────────────────────────┬────────╮
+│ Dimension                        │     Score │ Grade │ Progress                 │ Issues │
+├──────────────────────────────────┼───────────┼───────┼──────────────────────────┼────────┤
+│ Foundational Compliance          │  75.0/100 │     C │ ███████████████░░░░░     │      1 │
+│ Developer Experience             │  38.5/100 │     F │ ███████░░░░░░░░░░░░░░    │      3 │
+│ AI-Readiness & Agent Experience  │  31.2/100 │     F │ ██████░░░░░░░░░░░░░░░    │      4 │
+│ ...                              │       ... │   ... │ ...                      │    ... │
+╰──────────────────────────────────┴───────────┴───────┴──────────────────────────┴────────╯
+
+Issues & Recommendations
+
+  AI-Readiness & Agent Experience
+    x 4/6 operations lack descriptive intent (need >30 char description)
+       paths.*.*.description
+    ! 5/6 operations have no documented error responses (4xx/5xx) — agents cannot handle failure gracefully
+       paths.*.*.responses
+```
+
+## JSON output
+
+Pass `--json` to get a machine-readable report:
+
+```bash
+api-scorecard score openapi.yaml --json | jq '.overall_score'
+```
+
+```json
+{
+  "api_name": "Task Manager API",
+  "api_version": "1.0.0",
+  "spec_path": "openapi.yaml",
+  "overall_score": 42.3,
+  "grade": "F",
+  "dimensions": [
+    {
+      "name": "Foundational Compliance",
+      "score": 75.0,
+      "grade": "C",
+      "issues": [...]
+    }
+  ]
+}
+```
+
+## Development
+
+```bash
+# Install with dev dependencies
+uv pip install -e .
+
+# Run directly without installing
+python main.py score path/to/spec.yaml
+```

reuse_api-0.1.0/README.md

@@ -0,0 +1,149 @@
+# api-scorecard
+
+A CLI tool that scores OpenAPI specs for AI-readiness across 6 dimensions — giving APIs a letter grade and actionable recommendations so they work well with AI agents and LLM tooling.
+
+## Installation
+
+```bash
+# With uv (recommended)
+uv pip install -e .
+
+# Or with pip
+pip install -e .
+```
+
+## Usage
+
+### Scorecard
+
+```bash
+# Score an OpenAPI spec
+api-scorecard score path/to/openapi.yaml
+
+# Output as JSON
+api-scorecard score path/to/openapi.yaml --json
+
+# Run against the built-in sample spec to see how scoring works
+api-scorecard demo
+api-scorecard demo --json
+```
+
+### Sandbox
+
+The sandbox spins up a local mock server from your spec and auto-probes every endpoint, reporting a **feasibility score** — how well the spec can actually be exercised by an agent.
+
+```bash
+# Start a persistent mock server (press Ctrl+C to stop)
+api-scorecard sandbox start path/to/openapi.yaml
+api-scorecard sandbox start path/to/openapi.yaml --port 9000
+
+# Probe all endpoints and get a report
+api-scorecard sandbox probe path/to/openapi.yaml
+api-scorecard sandbox probe path/to/openapi.yaml --json
+
+# Run against the built-in sample spec
+api-scorecard sandbox demo
+api-scorecard sandbox demo --json
+```
+
+The `probe` command:
+1. Starts an internal mock server
+2. Generates synthetic request payloads and path parameters from the spec's schemas
+3. Fires requests at every operation
+4. Reports per-endpoint status codes, response times, and any issues found
+5. Exits with code `2` if the feasibility score is below 50%
+
+### Exit codes
+
+| Code | Meaning |
+|------|---------|
+| `0` | Success / score ≥ threshold |
+| `1` | Error reading or parsing the spec |
+| `2` | Score below threshold (< 60 for scorecard, < 50% for sandbox) |
+
+## What gets scored
+
+Each spec is evaluated across 6 weighted dimensions:
+
+| Dimension | Weight | What it checks |
+|-----------|--------|----------------|
+| **Foundational Compliance** | 20% | OpenAPI version, `info` object, paths defined, spec validity |
+| **Developer Experience** | 15% | Operation IDs, summaries, request/response examples, parameter descriptions |
+| **AI-Readiness & Agent Experience** | 20% | Meaningful descriptions, error responses (4xx/5xx), response schemas, schema property descriptions |
+| **Agent Usability** | 20% | Semantic operation IDs, tag usage, parameter schemas, request body documentation |
+| **Security & Governance** | 15% | Security schemes defined, operations secured, auth documentation |
+| **AI Discoverability** | 10% | API-level description, tags defined, external docs |
+
+### Grading
+
+| Score | Grade |
+|-------|-------|
+| 90–100 | A |
+| 80–89 | B |
+| 70–79 | C |
+| 60–69 | D |
+| < 60 | F |
+
+## Example output
+
+```
+╭─ API AI Readiness Scorecard ──────────────────────────────────╮
+│  Task Manager API  v1.0.0                                      │
+│  sample_spec.yaml                                              │
+│                                                                │
+│  Overall Score: 42.3/100  Grade: F                             │
+╰────────────────────────────────────────────────────────────────╯
+
+╭──────────────────────────────────┬───────────┬───────┬──────────────────────────┬────────╮
+│ Dimension                        │     Score │ Grade │ Progress                 │ Issues │
+├──────────────────────────────────┼───────────┼───────┼──────────────────────────┼────────┤
+│ Foundational Compliance          │  75.0/100 │     C │ ███████████████░░░░░     │      1 │
+│ Developer Experience             │  38.5/100 │     F │ ███████░░░░░░░░░░░░░░    │      3 │
+│ AI-Readiness & Agent Experience  │  31.2/100 │     F │ ██████░░░░░░░░░░░░░░░    │      4 │
+│ ...                              │       ... │   ... │ ...                      │    ... │
+╰──────────────────────────────────┴───────────┴───────┴──────────────────────────┴────────╯
+
+Issues & Recommendations
+
+  AI-Readiness & Agent Experience
+    x 4/6 operations lack descriptive intent (need >30 char description)
+       paths.*.*.description
+    ! 5/6 operations have no documented error responses (4xx/5xx) — agents cannot handle failure gracefully
+       paths.*.*.responses
+```
+
+## JSON output
+
+Pass `--json` to get a machine-readable report:
+
+```bash
+api-scorecard score openapi.yaml --json | jq '.overall_score'
+```
+
+```json
+{
+  "api_name": "Task Manager API",
+  "api_version": "1.0.0",
+  "spec_path": "openapi.yaml",
+  "overall_score": 42.3,
+  "grade": "F",
+  "dimensions": [
+    {
+      "name": "Foundational Compliance",
+      "score": 75.0,
+      "grade": "C",
+      "issues": [...]
+    }
+  ]
+}
+```
+
+## Development
+
+```bash
+# Install with dev dependencies
+uv pip install -e .
+
+# Run directly without installing
+python main.py score path/to/spec.yaml
+```