Pv/collections validate items link rel (#81)

* validate Collection has items link rel

* update contributing and reaDME

* update tests matric

* enable mypy

* enable typeguard

* fix nox mypy run

* disable windows and macos test runs

Author: philvarner

.github/workflows/tests.yml

@@ -14,15 +14,11 @@ jobs:
         include:
           - { python: "3.10", os: "ubuntu-latest", session: "pre-commit" }
           - { python: "3.10", os: "ubuntu-latest", session: "safety" }
-          #          - { python: "3.10", os: "ubuntu-latest", session: "mypy" }
-          #          - { python: "3.9", os: "ubuntu-latest", session: "mypy" }
-          #          - { python: "3.8", os: "ubuntu-latest", session: "mypy" }
+          - { python: "3.10", os: "ubuntu-latest", session: "mypy" }
           - { python: "3.10", os: "ubuntu-latest", session: "tests" }
-          - { python: "3.9", os: "ubuntu-latest", session: "tests" }
-          - { python: "3.8", os: "ubuntu-latest", session: "tests" }
-          - { python: "3.10", os: "windows-latest", session: "tests" }
-          - { python: "3.10", os: "macos-latest", session: "tests" }
-          #          - { python: "3.10", os: "ubuntu-latest", session: "typeguard" }
+          #          - { python: "3.10", os: "windows-latest", session: "tests" }
+          #          - { python: "3.10", os: "macos-latest", session: "tests" }
+          - { python: "3.10", os: "ubuntu-latest", session: "typeguard" }
           - { python: "3.10", os: "ubuntu-latest", session: "xdoctest" }
           - { python: "3.10", os: "ubuntu-latest", session: "docs-build" }
 

.pre-commit-config.yaml

@@ -64,9 +64,9 @@ repos:
     rev: v2.6.0
     hooks:
       - id: prettier
-#  - repo: https://github.com/pre-commit/mirrors-mypy
-#    rev: v0.971
-#    hooks:
-#      - id: mypy
-#        exclude: '(test_.*|noxfile)\.py'
-#        additional_dependencies: ["types-requests", "types-click"]
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.981
+    hooks:
+      - id: mypy
+        exclude: '(test_.*|noxfile)\.py'
+        additional_dependencies: ["types-requests", "types-click"]

CONTRIBUTING.md

@@ -37,7 +37,7 @@ Request features on the [Issue Tracker].
 
 ## How to set up your development environment
 
-You need Python 3.7+ and the following tools:
+You need Python 3.10 and the following tools:
 
 - [Poetry]
 - [Nox]
@@ -57,6 +57,8 @@ $ poetry run python
 $ poetry run stac-api-validator
 ```
 
+Note: if `poetry update` or `poetry install` hang, try running `poetry cache clear --all pypi` to fix the issue.
+
 [poetry]: https://python-poetry.org/
 [nox]: https://nox.thea.codes/
 [nox-poetry]: https://nox-poetry.readthedocs.io/

README.md

@@ -21,6 +21,11 @@
 [pre-commit]: https://github.com/pre-commit/pre-commit
 [black]: https://github.com/psf/black
 
+## Introduction
+
+The STAC API Validator is the official validation suite for the
+[STAC API](https://github.com/radiantearth/stac-api-spec/) family of specifications.
+
 ## Installation
 
 STAC API Validator requires Python 3.10.
@@ -39,30 +44,15 @@ $ stac-api-validator \
     --conformance core --conformance item-search
 ```
 
-To install from a clone of this repository for development, install [Poetry 1.2](https://python-poetry.org/docs/),
-and then install the package with development requirements:
-
-```console
-$ poetry install
-```
-
-Note: if `poetry update` or `poetry install` hang, try running `poetry cache clear --all pypi` to fix the issue.
-
-You can now run the command-line interface:
+## Contributing
 
-```console
-$ poetry run stac-api-validator
-```
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
 
 ## Usage
 
 Please see the [Command-line Reference] for details.
 
-## Contributing
-
-Contributions are very welcome.
-To learn more, see the [Contributor Guide].
-
 ## Features
 
 **Work in Progress** -- this currently only validates a subset of behavior

noxfile.py

@@ -151,7 +151,7 @@ def mypy(session: Session) -> None:
     """Type-check using mypy."""
     args = session.posargs or ["src", "tests", "docs/conf.py"]
     session.install(".")
-    session.install("mypy", "pytest")
+    session.install("mypy", "pytest", "types-requests")
     session.run("mypy", *args)
     if not session.posargs:
         session.run("mypy", f"--python-executable={sys.executable}", "noxfile.py")

poetry.lock

@@ -35,7 +35,7 @@ flake8-docstrings = ">=1.6.0"
 flake8-rst-docstrings = ">=0.2.5"
 furo = ">=2021.11.12"
 isort = ">=5.10.1"
-mypy = ">=0.971"
+mypy = ">=0.981"
 pep8-naming = ">=0.12.1"
 pre-commit = ">=2.16.0"
 pre-commit-hooks = ">=4.1.0"