amati 0.1.1__tar.gz → 0.2.1__tar.gz

amati-0.2.1/.dockerignore

@@ -0,0 +1 @@
+.venv

{amati-0.1.1 → amati-0.2.1}/.github/dependabot.yml

@@ -1,6 +1,5 @@
 version: 2
 updates:
-  # Enable version updates for npm
   - package-ecosystem: "uv"
     # Look for `uv.lock` file in the root directory.
     directory: "/"
@@ -8,7 +7,6 @@ updates:
     schedule:
       interval: "daily"
 
-  # Enable version updates for GitHub Actions
   - package-ecosystem: "github-actions"
     # Workflow files stored in the default location of `.github/workflows`
     # You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.
@@ -18,3 +16,9 @@ updates:
     allow:
       - dependency-type: "direct"
       - dependency-type: "indirect"
+
+  - package-ecosystem: "docker"
+    # Look for `Dockerfile` in the root directory
+    directory: "/"
+    schedule:
+      interval: "weekly"

amati-0.2.1/.github/workflows/checks.yaml

@@ -0,0 +1,90 @@
+name: Checks
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: dorny/paths-filter@v3
+        id: check_changes
+        with:
+          filters: |
+            relevant:
+              - '**/*.py'
+              - '**/*.sh'
+              - '**/*.json'
+              - '**/*.html'
+              - '**/*.toml'
+              - '**/*.lock'
+              - 'tests/**/*.yaml'
+              - '.pylintrc'
+              - '.python-version'
+              - '.Dockerfile'
+      
+      - name: Skip message
+        if: ${{ !(steps.check_changes.outputs.relevant == 'true') }}
+        run: echo "Skipping Python checks - no relevant changes detected"
+
+
+      - name: Install uv
+        if: steps.check_changes.outputs.relevant == 'true'
+        uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python
+        if: steps.check_changes.outputs.relevant == 'true'
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+
+      - name: Install the project
+        if: steps.check_changes.outputs.relevant == 'true'
+        run: uv sync --locked --all-extras --dev
+
+      - name: Formatting
+        if: steps.check_changes.outputs.relevant == 'true'
+        run: uv run black .
+
+      - name: Import sorting
+        if: steps.check_changes.outputs.relevant == 'true'
+        run: uv run isort .
+
+      - name: Linting
+        if: steps.check_changes.outputs.relevant == 'true'
+        run: uv run pylint amati
+      
+      - name: Test Linting
+        if: steps.check_changes.outputs.relevant == 'true'
+        run: uv run pylint tests
+
+      - name: Testing
+        if: steps.check_changes.outputs.relevant == 'true'
+        run: uv run pytest -m"not external" --cov
+
+      - name: Doctests
+        if: steps.check_changes.outputs.relevant == 'true'
+        run: uv run pytest --doctest-modules amati/
+
+      - name: Coverage comment
+        if: steps.check_changes.outputs.relevant == 'true'
+        id: coverage_comment
+        uses: py-cov-action/python-coverage-comment-action@v3
+        with:
+          GITHUB_TOKEN: ${{ github.token }}
+
+      - name: Store Pull Request comment to be posted
+        if: steps.check_changes.outputs.run_python_checks == 'true'
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-coverage-comment-action
+          path: python-coverage-comment-action.txt

amati-0.2.1/.github/workflows/publish.yaml

@@ -0,0 +1,47 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+
+jobs:
+  run:
+    name: "Build and publish release"
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for OIDC authentication
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version-file: ".python-version"
+      - name: Build
+        run: uv build
+      - name: Publish to PyPI test
+        run: uv publish --index testpypi
+      - name: Publish
+        run: uv publish
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USER }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags:  |
+            ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_REPO }}:${{ github.event.release.tag_name }}-alpha.1
+            ${{ secrets.DOCKERHUB_USERNAME }}/${{ secrets.DOCKERHUB_REPO }}:alpha

amati-0.2.1/.python-version

@@ -0,0 +1 @@
+3.13.5

amati-0.2.1/Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.13-slim
+
+ENV PYTHONUNBUFFERED=1
+
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /uvx /bin/
+
+WORKDIR /app
+COPY pyproject.toml uv.lock README.md ./
+COPY amati/ amati/
+
+RUN uv sync --locked --no-dev
+
+RUN adduser --disabled-password --gecos '' appuser && chown -R appuser /app
+USER appuser
+
+ENTRYPOINT ["uv", "run", "python", "amati/amati.py"]

amati-0.2.1/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: amati
+Version: 0.2.1
+Summary: Validates that a .yaml or .json file conforms to the OpenAPI Specifications 3.x.
+Project-URL: Homepage, https://github.com/ben-alexander/amati
+Project-URL: Issues, https://github.com/ben-alexander/amati/issues
+Author-email: Ben <2551337+ben-alexander@users.noreply.github.com>
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Testing :: Acceptance
+Requires-Python: >=3.13
+Requires-Dist: abnf>=2.3.1
+Requires-Dist: idna>=3.10
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: jsonpickle>=4.1.1
+Requires-Dist: jsonschema>=4.24.0
+Requires-Dist: pydantic>=2.11.5
+Requires-Dist: pyyaml>=6.0.2
+Description-Content-Type: text/markdown
+
+# amati
+
+amati is designed to validate that a file conforms to the [OpenAPI Specification v3.x](https://spec.openapis.org/) (OAS).
+
+## Name
+
+"amati" means to observe in Malay, especially with attention to detail. It's also one of the plurals of beloved or favourite in Italian.
+
+## Usage
+
+```sh
+python amati/amati.py --help
+usage: amati [-h] [-s SPEC] [-cc] [-d DISCOVER] [-l] [-hr]
+
+Tests whether a OpenAPI specification is valid. Will look an openapi.json or openapi.yaml file in the directory that
+amati is called from. If --discover is set will search the directory tree. If the specification does not follow the
+naming recommendation the --spec switch should be used. Creates a file <filename>.errors.json alongside the original
+specification containing a JSON representation of all the errors.
+
+options:
+  -h, --help            show this help message and exit
+  -s, --spec SPEC       The specification to be parsed
+  -cc, --consistency-check
+                        Runs a consistency check between the input specification and the parsed specification
+  -d, --discover DISCOVER
+                        Searches the specified directory tree for openapi.yaml or openapi.json.
+  -l, --local           Store errors local to the caller in a file called <file-name>.errors.json; a .amati/ directory
+                        will be created.
+  -hr, --html-report    Creates an HTML report of the errors, called <file-name>.errors.html, alongside the original
+                        file or in a .amati/ directory if the --local switch is used
+```
+
+A Dockerfile is available on [DockerHub](https://hub.docker.com/r/benale/amati/tags)
+
+To run against a specific specification the location of the specification needs to be mounted in the container.
+
+```sh
+docker run -v "<path-to-mount>:/<mount-name> amati:alpha <options>
+```
+
+e.g. 
+
+```sh
+docker run -v /Users/myuser/myrepo:/data amati:alpha --spec data/myspec.yaml --hr
+```
+
+## Architecture
+
+amati uses Pydantic, especially the validation, and Typing to construct the entire OAS as a single data type. Passing a dictionary to the top-level data type runs all the validation in the Pydantic models constructing a single set of inherited classes and datatypes that validate that the API specification is accurate. To the extent that Pydantic is functional, amati has a [functional core and an imperative shell](https://www.destroyallsoftware.com/screencasts/catalog/functional-core-imperative-shell).
+
+Where the specification conforms, but relies on implementation-defined behavior (e.g. [data type formats](https://spec.openapis.org/oas/v3.1.1.html#data-type-format)), a warning will be raised.
+
+## Contributing
+
+### Prerequisites
+
+* The latest version of [uv](https://docs.astral.sh/uv/)
+* [git 2.49+](https://git-scm.com/downloads/linux)
+* [Docker](https://docs.docker.com/engine/install/)
+
+### Starting
+
+The project uses a [`pyproject.toml` file](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#writing-pyproject-toml) to determine what to build.
+
+To get started run:
+
+```sh
+uv python install
+uv venv
+uv sync
+```
+
+### Testing and formatting
+
+This project uses:
+
+* [Pytest](https://docs.pytest.org/en/stable/) as a testing framework
+* [Pyright](https://microsoft.github.io/pyright/#/) on strict mode for type checking
+* [Pylint](https://www.pylint.org/) as a linter, using a modified version from [Google's style guide](https://google.github.io/styleguide/pyguide.html)
+* [Hypothesis](https://hypothesis.readthedocs.io/en/latest/index.html) for test data generation
+* [Coverage](https://coverage.readthedocs.io/en/7.6.8/) on both the tests and code for test coverage
+* [Black](https://black.readthedocs.io/en/stable/index.html) for automated formatting
+* [isort](https://pycqa.github.io/isort/) for import sorting
+
+It's expected that there are no errors and 100% of the code is reached and executed. The strategy for test coverage is based on parsing test specifications and not unit tests.
+amati runs tests on the external specifications, detailed in `tests/data/.amati.tests.yaml`. To be able to run these tests the GitHub repos containing the specifications need to be available locally. Specific revisions of the repos can be downloaded by running the following, which will clone the repos into `../amati-tests-specs/<repo-name>`.
+
+```sh
+python scripts/tests/setup_test_specs.py
+```
+
+If there are some issues with the specification a JSON file detailing those should be placed into `tests/data/` and the name of that file noted in `tests/data/.amati.tests.yaml` for the test suite to pick it up and check that the errors are expected. Any specifications that close the coverage gap are gratefully received.
+
+To run everything, from linting, type checking to downloading test specs and building and testing the Docker image run:
+
+```sh
+sh bin/checks.sh
+```
+
+### Docker
+
+A development Docker image is provided, `Dockerfile.dev`, to build:
+
+```sh
+docker build -t amati -f Dockerfile .
+```
+
+to run against a specific specification the location of the specification needs to be mounted in the container.
+
+```sh
+docker run -v "<path-to-mount>:/<mount-name> amati <options>
+```
+
+This can be tested against a provided specification, from the root directory
+
+```sh
+docker run --detach -v "$(pwd):/data" amati <options>
+```
+
+
+### Data
+
+There are some scripts to create the data needed by the project, for example, all the registered TLDs. To refresh the data, run the contents of `/scripts/data`.
+
+
+
+

amati-0.2.1/README.md

@@ -0,0 +1,127 @@
+# amati
+
+amati is designed to validate that a file conforms to the [OpenAPI Specification v3.x](https://spec.openapis.org/) (OAS).
+
+## Name
+
+"amati" means to observe in Malay, especially with attention to detail. It's also one of the plurals of beloved or favourite in Italian.
+
+## Usage
+
+```sh
+python amati/amati.py --help
+usage: amati [-h] [-s SPEC] [-cc] [-d DISCOVER] [-l] [-hr]
+
+Tests whether a OpenAPI specification is valid. Will look an openapi.json or openapi.yaml file in the directory that
+amati is called from. If --discover is set will search the directory tree. If the specification does not follow the
+naming recommendation the --spec switch should be used. Creates a file <filename>.errors.json alongside the original
+specification containing a JSON representation of all the errors.
+
+options:
+  -h, --help            show this help message and exit
+  -s, --spec SPEC       The specification to be parsed
+  -cc, --consistency-check
+                        Runs a consistency check between the input specification and the parsed specification
+  -d, --discover DISCOVER
+                        Searches the specified directory tree for openapi.yaml or openapi.json.
+  -l, --local           Store errors local to the caller in a file called <file-name>.errors.json; a .amati/ directory
+                        will be created.
+  -hr, --html-report    Creates an HTML report of the errors, called <file-name>.errors.html, alongside the original
+                        file or in a .amati/ directory if the --local switch is used
+```
+
+A Dockerfile is available on [DockerHub](https://hub.docker.com/r/benale/amati/tags)
+
+To run against a specific specification the location of the specification needs to be mounted in the container.
+
+```sh
+docker run -v "<path-to-mount>:/<mount-name> amati:alpha <options>
+```
+
+e.g. 
+
+```sh
+docker run -v /Users/myuser/myrepo:/data amati:alpha --spec data/myspec.yaml --hr
+```
+
+## Architecture
+
+amati uses Pydantic, especially the validation, and Typing to construct the entire OAS as a single data type. Passing a dictionary to the top-level data type runs all the validation in the Pydantic models constructing a single set of inherited classes and datatypes that validate that the API specification is accurate. To the extent that Pydantic is functional, amati has a [functional core and an imperative shell](https://www.destroyallsoftware.com/screencasts/catalog/functional-core-imperative-shell).
+
+Where the specification conforms, but relies on implementation-defined behavior (e.g. [data type formats](https://spec.openapis.org/oas/v3.1.1.html#data-type-format)), a warning will be raised.
+
+## Contributing
+
+### Prerequisites
+
+* The latest version of [uv](https://docs.astral.sh/uv/)
+* [git 2.49+](https://git-scm.com/downloads/linux)
+* [Docker](https://docs.docker.com/engine/install/)
+
+### Starting
+
+The project uses a [`pyproject.toml` file](https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#writing-pyproject-toml) to determine what to build.
+
+To get started run:
+
+```sh
+uv python install
+uv venv
+uv sync
+```
+
+### Testing and formatting
+
+This project uses:
+
+* [Pytest](https://docs.pytest.org/en/stable/) as a testing framework
+* [Pyright](https://microsoft.github.io/pyright/#/) on strict mode for type checking
+* [Pylint](https://www.pylint.org/) as a linter, using a modified version from [Google's style guide](https://google.github.io/styleguide/pyguide.html)
+* [Hypothesis](https://hypothesis.readthedocs.io/en/latest/index.html) for test data generation
+* [Coverage](https://coverage.readthedocs.io/en/7.6.8/) on both the tests and code for test coverage
+* [Black](https://black.readthedocs.io/en/stable/index.html) for automated formatting
+* [isort](https://pycqa.github.io/isort/) for import sorting
+
+It's expected that there are no errors and 100% of the code is reached and executed. The strategy for test coverage is based on parsing test specifications and not unit tests.
+amati runs tests on the external specifications, detailed in `tests/data/.amati.tests.yaml`. To be able to run these tests the GitHub repos containing the specifications need to be available locally. Specific revisions of the repos can be downloaded by running the following, which will clone the repos into `../amati-tests-specs/<repo-name>`.
+
+```sh
+python scripts/tests/setup_test_specs.py
+```
+
+If there are some issues with the specification a JSON file detailing those should be placed into `tests/data/` and the name of that file noted in `tests/data/.amati.tests.yaml` for the test suite to pick it up and check that the errors are expected. Any specifications that close the coverage gap are gratefully received.
+
+To run everything, from linting, type checking to downloading test specs and building and testing the Docker image run:
+
+```sh
+sh bin/checks.sh
+```
+
+### Docker
+
+A development Docker image is provided, `Dockerfile.dev`, to build:
+
+```sh
+docker build -t amati -f Dockerfile .
+```
+
+to run against a specific specification the location of the specification needs to be mounted in the container.
+
+```sh
+docker run -v "<path-to-mount>:/<mount-name> amati <options>
+```
+
+This can be tested against a provided specification, from the root directory
+
+```sh
+docker run --detach -v "$(pwd):/data" amati <options>
+```
+
+
+### Data
+
+There are some scripts to create the data needed by the project, for example, all the registered TLDs. To refresh the data, run the contents of `/scripts/data`.
+
+
+
+

amati-0.2.1/TEMPLATE.html

@@ -0,0 +1,116 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>amati</title>
+    <!-- Tailwind CSS CDN -->
+    <script src="https://cdn.tailwindcss.com"></script>
+    <style>
+        body {
+            font-family: "Inter", sans-serif;
+            background-color: #f3f4f6;
+            display: flex;
+            justify-content: center;
+            align-items: flex-start;
+            min-height: 100vh;
+            padding: 2rem;
+            box-sizing: border-box;
+        }
+        .container {
+            background-color: #ffffff;
+            padding: 2rem;
+            border-radius: 1rem;
+            box-shadow: 0 4px 6px rgba(0, 0, 0, 0.1);
+            width: 100%;
+            max-width: 1200px; /* Increased max-width for more columns */
+            overflow-x: auto; /* Added for horizontal scrolling on small screens */
+        }
+        table {
+            width: 100%;
+            border-collapse: collapse;
+        }
+        th, td {
+            padding: 0.75rem;
+            text-align: left;
+            border-bottom: 1px solid #e5e7eb;
+        }
+        th {
+            background-color: #f9fafb;
+            font-weight: 600;
+            color: #4b5563;
+            text-transform: uppercase;
+            font-size: 0.875rem;
+        }
+        tr:hover {
+            background-color: #f3f4f6;
+        }
+        .code-block {
+            background-color: #e0e7ff;
+            padding: 0.25rem 0.5rem;
+            border-radius: 0.375rem;
+            font-family: monospace;
+            color: #4f46e5;
+            white-space: nowrap; /* Prevent line breaks for code */
+        }
+        .error-url {
+            color: #3b82f6;
+            text-decoration: none;
+        }
+        .error-url:hover {
+            text-decoration: underline;
+        }
+    </style>
+</head>
+<body>
+    <div class="container">
+        <h1 class="text-3xl font-bold text-center text-gray-800 mb-6">amati error report</h1>
+
+        {% if errors %}
+            <div class="overflow-x-auto rounded-lg shadow-sm border border-gray-200">
+                <table class="min-w-full divide-y divide-gray-200">
+                    <thead class="bg-gray-50">
+                        <tr>
+                            <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider rounded-tl-lg">Type</th>
+                            <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">Location</th>
+                            <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">Message</th>
+                            <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider">Input</th>
+                            <th scope="col" class="px-6 py-3 text-left text-xs font-medium text-gray-500 uppercase tracking-wider rounded-tr-lg">URL</th>
+                        </tr>
+                    </thead>
+                    <tbody class="bg-white divide-y divide-gray-200">
+                        {% for item in errors %}
+                            <tr>
+                                <td class="px-6 py-4 whitespace-nowrap text-sm font-medium text-gray-900">{{ item.type | default('N/A') }}</td>
+                                <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500">
+                                    <code class="code-block">
+                                        {# Check if 'loc' exists and is iterable before joining #}
+                                        {% if item.loc is defined and item.loc is iterable %}
+                                            {{ item.loc | join(' -> ') }}
+                                        {% else %}
+                                            N/A
+                                        {% endif %}
+                                    </code>
+                                </td>
+                                <td class="px-6 py-4 text-sm text-gray-500">{{ item.msg | default('N/A') }}</td>
+                                <td class="px-6 py-4 whitespace-nowrap text-sm text-gray-500">
+                                    <code class="code-block">
+                                        {% if item.input is defined and item.input %}
+                                            {{ item.input | default('N/A') }}
+                                        {% else %}
+                                            N/A
+                                        {% endif %}
+                                    </code>
+                                </td>
+                                <td class="px-6 py-4 whitespace-nowrap text-sm text-blue-600"><a href="{{ item.url | default('#') }}" class="error-url" target="_blank">{{ item.url | default('N/A') }}</a></td>
+                            </tr>
+                        {% endfor %}
+                    </tbody>
+                </table>
+            </div>
+        {% else %}
+            <p class="text-center text-gray-600 mt-8">No data available to display.</p>
+        {% endif %}
+    </div>
+</body>
+</html>

{amati-0.1.1 → amati-0.2.1}/amati/__init__.py

@@ -13,4 +13,3 @@ __version__ = importlib.metadata.version("amati")
 
 from amati.amati import dispatch, run
 from amati.exceptions import AmatiValueError
-from amati.references import AmatiReferenceException, Reference, References

amati-0.2.1/amati/_error_handler.py

@@ -0,0 +1,48 @@
+"""
+Handles Pydantic errors and amati logs to provide a consistent view to the user.
+"""
+
+import json
+from typing import cast
+
+from amati.logging import Log
+
+type JSONPrimitive = str | int | float | bool | None
+type JSONArray = list["JSONValue"]
+type JSONObject = dict[str, "JSONValue"]
+type JSONValue = JSONPrimitive | JSONArray | JSONObject
+
+
+def remove_duplicates(data: list[JSONObject]) -> list[JSONObject]:
+    """
+    Remove duplicates by converting each dict to a JSON string for comparison.
+    """
+    seen: set[str] = set()
+    unique_data: list[JSONObject] = []
+
+    for item in data:
+        # Convert to JSON string with sorted keys for consistent hashing
+        item_json = json.dumps(item, sort_keys=True, separators=(",", ":"))
+        if item_json not in seen:
+            seen.add(item_json)
+            unique_data.append(item)
+
+    return unique_data
+
+
+def handle_errors(errors: list[JSONObject] | None, logs: list[Log]) -> list[JSONObject]:
+    """
+    Makes errors and logs consistent for user consumption.
+    """
+
+    result: list[JSONObject] = []
+
+    if errors:
+        result.extend(errors)
+
+    if logs:
+        result.extend(cast(list[JSONObject], logs))
+
+    result = remove_duplicates(result)
+
+    return result