specscore 0.1.4__tar.gz

specscore-0.1.4/.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

specscore-0.1.4/.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/specscore/
+    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 }}

specscore-0.1.4/.gitignore

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

specscore-0.1.4/.python-version

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

specscore-0.1.4/LICENSE

@@ -0,0 +1,193 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and derivative works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any
+      Contribution embodied within the Work constitutes direct or contributory
+      patent infringement, then any patent licenses granted to You under
+      this License for that Work shall terminate as of the date such
+      litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or as an addendum to
+          the NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+      You may add Your own license statement for Your contributions and
+      may provide additional grant of rights to use, copy, modify, and
+      distribute those contributions under terms of Your choice, provided
+      Your use, reproduction, and distribution of the Work otherwise
+      complies with the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Liability. While redistributing the Work or
+      Derivative Works thereof, You may choose to offer, and charge a fee
+      for, acceptance of support, warranty, indemnity, or other liability
+      obligations and/or rights consistent with this License. However, in
+      accepting such obligations, You may offer such obligations only on
+      Your own behalf and on Your sole responsibility, not on behalf of
+      any other Contributor, and only if You agree to indemnify, defend,
+      and hold each Contributor harmless for any liability incurred by, or
+      claims asserted against, such Contributor by reason of your accepting
+      any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the format in question. Please also include a
+      full copy of this License with any redistribution.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

specscore-0.1.4/NOTICE

@@ -0,0 +1,14 @@
+Jentic API AI-Readiness Framework (JAIRF)
+Copyright (c) 2025-2026 Jentic
+Jentic API AI-Readiness Framework (JAIRF) is licensed under Apache 2.0 license.
+
+cli-jentic is a derivative CLI implementation of the Jentic API AI-Readiness
+Framework (JAIRF). The scorecard scoring model, dimension definitions, and
+grading logic in the scorecard/ package are derived from JAIRF.
+
+Original contributions in cli-jentic (sandbox/, clitic/, and the GitHub Pages
+site) are copyright (c) 2025-2026 SheepSeb and are also made available under
+the Apache License, Version 2.0.
+
+You may obtain a copy of the Apache License at:
+    http://www.apache.org/licenses/LICENSE-2.0

specscore-0.1.4/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.4
+Name: specscore
+Version: 0.1.4
+Summary: OpenAPI scoring, sandbox, and CLI tool scoring for AI-ready agents — specscore
+Project-URL: Homepage, https://sheepseb.github.io/specscore
+Project-URL: Repository, https://github.com/SheepSeb/specscore
+Project-URL: Bug Tracker, https://github.com/SheepSeb/specscore/issues
+Author: SheepSeb
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: agentic,agents,ai,api,cli,clitic,llm,mock-server,openapi,sandbox,scorecard
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software 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
+
+# specscore
+
+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
+specscore score path/to/openapi.yaml
+
+# Output as JSON
+specscore score path/to/openapi.yaml --json
+
+# Run against the built-in sample spec to see how scoring works
+specscore demo
+specscore 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)
+specscore sandbox start path/to/openapi.yaml
+specscore sandbox start path/to/openapi.yaml --port 9000
+
+# Probe all endpoints and get a report
+specscore sandbox probe path/to/openapi.yaml
+specscore sandbox probe path/to/openapi.yaml --json
+
+# Run against the built-in sample spec
+specscore sandbox demo
+specscore 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
+
+```
+╭─ specscore · OpenAPI AI readiness ───────────────────────────╮
+│  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
+specscore 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
+```
+
+## License
+
+The scorecard scoring model in this project (`scorecard/` package) is derived from the
+[Jentic API AI-Readiness Framework (JAIRF)](https://jentic.com), which is licensed under
+the Apache License, Version 2.0. See the [NOTICE](NOTICE) file for the required upstream
+attribution.
+
+Original contributions (sandbox, clitic, GitHub Pages site) are copyright (c) 2025-2026
+SheepSeb. The project as a whole is distributed under the Apache License, Version 2.0 —
+see the [LICENSE](LICENSE) file for details.

specscore-0.1.4/README.md

@@ -0,0 +1,160 @@
+# specscore
+
+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
+specscore score path/to/openapi.yaml
+
+# Output as JSON
+specscore score path/to/openapi.yaml --json
+
+# Run against the built-in sample spec to see how scoring works
+specscore demo
+specscore 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)
+specscore sandbox start path/to/openapi.yaml
+specscore sandbox start path/to/openapi.yaml --port 9000
+
+# Probe all endpoints and get a report
+specscore sandbox probe path/to/openapi.yaml
+specscore sandbox probe path/to/openapi.yaml --json
+
+# Run against the built-in sample spec
+specscore sandbox demo
+specscore 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
+
+```
+╭─ specscore · OpenAPI AI readiness ───────────────────────────╮
+│  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
+specscore 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
+```
+
+## License
+
+The scorecard scoring model in this project (`scorecard/` package) is derived from the
+[Jentic API AI-Readiness Framework (JAIRF)](https://jentic.com), which is licensed under
+the Apache License, Version 2.0. See the [NOTICE](NOTICE) file for the required upstream
+attribution.
+
+Original contributions (sandbox, clitic, GitHub Pages site) are copyright (c) 2025-2026
+SheepSeb. The project as a whole is distributed under the Apache License, Version 2.0 —
+see the [LICENSE](LICENSE) file for details.