add deprecation warning

Author: vincentsarago

Diff for: .github/workflows/cicd.yml

@@ -14,20 +14,21 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install tox codecov pre-commit
+          python -m pip install tox pre-commit
+          pre-commit install
 
       # Run tox using the version of Python in `PATH`
       - name: Run Tox

Diff for: .github/workflows/release.yml

@@ -1,6 +1,7 @@
 name: Release
 
 on:
+  workflow_dispatch:
   release:
     types:
       - created
@@ -11,22 +12,22 @@ jobs:
     runs-on: ubuntu-latest
     if: ${{ github.repository }} == 'stac-utils/stac-pydantic'
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Python 3.x
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v4
         with:
           python-version: "3.x"
 
       - name: Install release dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools wheel twine
+          python -m pip install build twine
 
       - name: Build and publish package
         env:
           TWINE_USERNAME: ${{ secrets.PYPI_STACUTILS_USERNAME }}
           TWINE_PASSWORD: ${{ secrets.PYPI_STACUTILS_PASSWORD }}
         run: |
-          python setup.py sdist bdist_wheel
+          python -m build
           twine upload dist/*

Diff for: .gitignore

@@ -106,6 +106,9 @@ celerybeat-schedule
 # dotenv
 .env
 
+# venv
+.venv
+
 # Spyder project settings
 .spyderproject
 .spyproject
@@ -117,4 +120,4 @@ celerybeat-schedule
 /site
 
 # skaffold temporary build/deploy files
-build.out
+build.out

Diff for: .pre-commit-config.yaml

@@ -1,27 +1,39 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
 repos:
-  - repo: https://github.com/psf/black
-    rev: 22.3.0
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.16
     hooks:
-      - id: black
-        language_version: python3
-        args: ["--safe"]
+      - id: validate-pyproject
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: check-yaml
+      - id: check-added-large-files
+        args: ["--maxkb=40960"]
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+    rev: 5.13.2
     hooks:
       - id: isort
-        language_version: python3
+        language_version: python
 
-  - repo: https://github.com/PyCQA/flake8
-    rev: 4.0.1
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.5
     hooks:
-      - id: flake8
-        language_version: python3
+      - id: ruff
+        args: ["--fix"]
+      - id: ruff-format
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v0.931
+    rev: v1.9.0
     hooks:
       - id: mypy
-        exclude: ^tests/
-        args: [--strict]
-        additional_dependencies: ["pydantic", "types-jsonschema", "types-setuptools", "types-requests"]
+        language_version: python
+        # No reason to run if only tests have changed. They intentionally break typing.
+        exclude: tests/.*
+        additional_dependencies:
+        - types-requests

Diff for: CHANGELOG.txt

@@ -1,6 +1,16 @@
-Unreleased
+3.1.0 (TBD)
+-----------------
+- Remove the deprecated `Context` extension (#138, @vincentsarago)
+- Rename `stac_pydantic.api.conformance.ConformanceClasses` to `stac_pydantic.api.conformance.Conformance`
+- Update pre-commit configuration and switch to astral-sh/ruff for linter and formater
+- Add official support for python 3.12
+- Enforce required `type` key for `Collection` and `Catalog` models
+- Add queryables link relation type (#123, @constantinius)
+- Fix STAC API Query Extension operator names from ne->neq, le->lte, and ge->gte (#120, @philvarner)
+
+3.0.0 (2024-01-25)
 ------------------
-- Fix STAC API Query Extension operator names from ne->neq, le->lte, and ge->gte
+- Support pydantic>2.0 (@huard)
 
 2.0.3 (2022-5-3)
 ------------------
@@ -106,4 +116,4 @@ Unreleased
 - Allow extra asset-level fields (#1)
 - Fix population by field name model config, allowing model creation without extension namespaces (#2)
 - Add enum of commonly used asset media types (#3)
-- Move geojson models to `geojson-pydantic` library (#4)
+- Move geojson models to `geojson-pydantic` library (#4)

Diff for: README.md

@@ -1,22 +1,33 @@
-# stac-pydantic ![tests](https://github.com/arturo-ai/stac-pydantic/workflows/cicd/badge.svg)
-[Pydantic](https://pydantic-docs.helpmanual.io/) models for [STAC](https://github.com/radiantearth/stac-spec) Catalogs, Collections, Items, and the [STAC API](https://github.com/radiantearth/stac-api-spec) spec.  Initially developed by [arturo-ai](https://github.com/arturo-ai).
+# stac-pydantic
+
+[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/stac-utils/stac-pydantic/cicd.yml?style=for-the-badge)](https://github.com/stac-utils/stac-pydantic/actions/workflows/cicd.yml)
+
+[Pydantic](https://pydantic-docs.helpmanual.io/) models for [STAC](https://github.com/radiantearth/stac-spec) Catalogs, Collections, Items, and the [STAC API](https://github.com/radiantearth/stac-api-spec) spec.
+Initially developed by [arturo-ai](https://github.com/arturo-ai).
+
+The main purpose of this library is to provide reusable request/response models for tools such as [fastapi](https://fastapi.tiangolo.com/).
+For more comprehensive schema validation and robust extension support, use [pystac](https://github.com/stac-utils/pystac).
 
 ## Installation
-```
+
+```shell
 pip install stac-pydantic
 ```
 
 For local development:
-```
-pip install -e .["dev"]
+
+```shell
+pip install -e '.[dev,lint]'
 ```
 
-| stac-pydantic | STAC Version |
-|---------------|--------------|
-| 1.1.x         | 0.9.0        |
-| 1.2.x         | 1.0.0-beta.1 |
-| 1.3.x         | 1.0.0-beta.2 |
-| 2.0.x         | 1.0.0        |
+| stac-pydantic | STAC Version | STAC API Version | Pydantic Version |
+|--------------|---------------|------------------|-----------------|
+| 1.2.x         | 1.0.0-beta.1 | <1* | ^1.6 |
+| 1.3.x         | 1.0.0-beta.2 | <1* | ^1.6 |
+| 2.0.x         | 1.0.0        | <1* | ^1.6 |
+| 3.0.x         | 1.0.0        | 1.0.0 | ^2.4 |
+
+\* various beta releases, specs not fully implemented
 
 ## Development
 
@@ -31,11 +42,11 @@ pre-commit install
 Ensure you have all Python versions installed that the tests will be run against. If using pyenv, run:
 
 ```shell
-pyenv install 3.7.12
-pyenv install 3.8.12 
-pyenv install 3.9.10
-pyenv install 3.10.2
-pyenv local 3.7.12 3.8.12 3.9.10 3.10.2
+pyenv install 3.8.18
+pyenv install 3.9.18
+pyenv install 3.10.13
+pyenv install 3.11.5
+pyenv local 3.8.18 3.9.18 3.10.13 3.11.5
 ```
 
 Run the entire test suite:
@@ -78,7 +89,8 @@ assert catalog.links[0].href == "item.json"
 ```
 
 ### Extensions
-STAC defines many extensions which let the user customize the data in their catalog. `stac-pydantic.extensions.validate_extensions` will validate a `dict`, `Item`, `Collection` or `Catalog` against the schema urls provided in the `stac_extensions` property: 
+
+STAC defines many extensions which let the user customize the data in their catalog. `stac-pydantic.extensions.validate_extensions` will validate a `dict`, `Item`, `Collection` or `Catalog` against the schema urls provided in the `stac_extensions` property:
 
 ```python
 from stac_pydantic import Item
@@ -88,41 +100,96 @@ stac_item = {
     "id": "12345",
     "type": "Feature",
     "stac_extensions": [
-        "https://stac-extensions.github.io/eo/v1.0.0/schema.json" 
+        "https://stac-extensions.github.io/eo/v1.0.0/schema.json"
     ],
     "geometry": { "type": "Point", "coordinates": [0, 0] },
+    "bbox": [0.0, 0.0, 0.0, 0.0],
     "properties": {
         "datetime": "2020-03-09T14:53:23.262208+00:00",
         "eo:cloud_cover": 25,
     },
     "links": [],
-    "assets": [],
+    "assets": {},
 }
 
-model = Item(**stac_item) 
+model = Item(**stac_item)
 validate_extensions(model, reraise_exception=True)
-assert getattr(model.properties, "eo:cloud_cover") == 25 
+assert getattr(model.properties, "eo:cloud_cover") == 25
 ```
 
 The complete list of current STAC Extensions can be found [here](https://stac-extensions.github.io/).
 
 #### Vendor Extensions
+
 The same procedure described above works for any STAC Extension schema as long as it can be loaded from a public url.
 
+### STAC API
+
+The [STAC API Specs](https://github.com/radiantearth/stac-api-spec) extent the core STAC specification for implementing dynamic catalogs. STAC Objects used in an API context should always import models from the `api` subpackage. This package extends
+Catalog, Collection, and Item models with additional fields and validation rules and introduces Collections and ItemCollections models and Pagination/ Search Links.
+It also implements models for defining ItemSeach queries.
+
+```python
+from stac_pydantic.api import Item, ItemCollection
+
+stac_item = Item(**{
+    "id": "12345",
+    "type": "Feature",
+    "stac_extensions": [],
+    "geometry": { "type": "Point", "coordinates": [0, 0] },
+    "bbox": [0.0, 0.0, 0.0, 0.0],
+    "properties": {
+        "datetime": "2020-03-09T14:53:23.262208+00:00",
+    },
+    "collection": "CS3",
+    "links": [
+          {
+            "rel": "self",
+            "href": "http://stac.example.com/catalog/collections/CS3-20160503_132130_04/items/CS3-20160503_132130_04.json"
+          },
+          {
+            "rel": "collection",
+            "href": "http://stac.example.com/catalog/CS3-20160503_132130_04/catalog.json"
+          },
+          {
+            "rel": "root",
+            "href": "http://stac.example.com/catalog"
+          }],
+    "assets": {},
+    })
+
+stac_item_collection = ItemCollection(**{
+    "type": "FeatureCollection",
+    "features": [stac_item],
+    "links": [
+          {
+            "rel": "self",
+            "href": "http://stac.example.com/catalog/search?collection=CS3",
+            "type": "application/geo+json"
+          },
+          {
+            "rel": "root",
+            "href": "http://stac.example.com/catalog",
+            "type": "application/json"
+          }],
+    })
+```
+
 ### Exporting Models
+
 Most STAC extensions are namespaced with a colon (ex `eo:gsd`) to keep them distinct from other extensions.  Because
 Python doesn't support the use of colons in variable names, we use [Pydantic aliasing](https://pydantic-docs.helpmanual.io/usage/model_config/#alias-generator)
 to add the namespace upon model export.  This requires [exporting](https://pydantic-docs.helpmanual.io/usage/exporting_models/)
-the model with the `by_alias = True` parameter.  A convenience method (``to_dict()``) is provided to export models with
-extension namespaces:
+the model with the `by_alias = True` parameter. Export methods (`model_dump()` and `model_dump_json()`) for models in this library have `by_alias` and `exclude_unset` st to `True` by default:
 
 ```python
-item_dict = item.to_dict()
+item_dict = item.model_dump()
 assert item_dict['properties']['landsat:row'] == item.properties.row == 250
 ```
 
 ### CLI
-```
+
+```text
 Usage: stac-pydantic [OPTIONS] COMMAND [ARGS]...
 
   stac-pydantic cli group