amati 0.2__py3-none-any.whl → 0.2.1__py3-none-any.whl

{amati-0.2.dist-info → amati-0.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: amati
-Version: 0.2
+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
@@ -28,7 +28,7 @@ amati is designed to validate that a file conforms to the [OpenAPI Specification
 
 ## 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.
+"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
 
@@ -59,34 +59,47 @@ A Dockerfile is available on [DockerHub](https://hub.docker.com/r/benale/amati/t
 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>
+docker run -v "<path-to-mount>:/<mount-name> amati:alpha <options>
 ```
 
 e.g. 
 
 ```sh
-docker run -v /Users/myuser/myrepo:/data amati --spec data/myspec.yaml --hr
+docker run -v /Users/myuser/myrepo:/data amati:alpha --spec data/myspec.yaml --hr
 ```
 
 ## Architecture
 
-This 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.
+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
 
-### Requirements
+### 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
-* [PyLance](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance) on strict mode for type checking
+* [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
@@ -94,33 +107,20 @@ This project uses:
 * [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 external specifications, detailed in `tests/data/.amati.tests.yaml`. To be able to run these tests the appropriate GitHub repos need to be local. Specific revisions of the repos can be downloaded by running
+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
 ```
 
-You will need to have Docker installed.
-
-### Building
-
-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 install, assuming that [uv](https://docs.astral.sh/uv/) is already installed and initialised
-
-```sh
-uv python install
-uv venv
-uv sync
-```
-
 ### Docker
 
 A development Docker image is provided, `Dockerfile.dev`, to build:
@@ -129,7 +129,7 @@ A development Docker image is provided, `Dockerfile.dev`, to build:
 docker build -t amati -f Dockerfile .
 ```
 
-and to run against a specific specification the location of the specification needs to be mounted in the container.
+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>
@@ -138,13 +138,13 @@ 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
+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 possible licences. If the data needs to be refreshed this can be done by running the contents of `/scripts/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.dist-info → amati-0.2.1.dist-info}/RECORD

@@ -30,8 +30,8 @@ amati/validators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,
 amati/validators/generic.py,sha256=AYIHIuEHpf1p-lCynBp-YGaayIZOylzNgGi533ykVbc,3983
 amati/validators/oas304.py,sha256=84sAc37azkgrOt29scjRtYtJGypnFZd5UkV9VGLsX8c,32472
 amati/validators/oas311.py,sha256=FVMOjNXWlZhq6fgah0NGGPlgdcSZFgVxVbEwWnk4Sn4,17712
-amati-0.2.dist-info/METADATA,sha256=pDJg9ueeR6-_otHva88kNPxiEy3e-AAMIRvxsc4RFhg,5916
-amati-0.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-amati-0.2.dist-info/entry_points.txt,sha256=sacBb6g0f0ZJtNjNYx93_Xe4y5xzawvklCFVXup9ru0,37
-amati-0.2.dist-info/licenses/LICENSE,sha256=WAA01ZXeNs1bwpNWKR6aVucjtYjYm_iQIUYkCAENjqM,1070
-amati-0.2.dist-info/RECORD,,
+amati-0.2.1.dist-info/METADATA,sha256=D2pXSaxSmc8pRwCdpqJNeGozaUZjKdsXvJ1BBODaF4Y,6425
+amati-0.2.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+amati-0.2.1.dist-info/entry_points.txt,sha256=sacBb6g0f0ZJtNjNYx93_Xe4y5xzawvklCFVXup9ru0,37
+amati-0.2.1.dist-info/licenses/LICENSE,sha256=WAA01ZXeNs1bwpNWKR6aVucjtYjYm_iQIUYkCAENjqM,1070
+amati-0.2.1.dist-info/RECORD,,