stac-fastapi.extensions 2.4.8__tar.gz → 2.5.0__tar.gz

stac_fastapi_extensions-2.5.0/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.1
+Name: stac-fastapi.extensions
+Version: 2.5.0
+Summary: An implementation of STAC API based on the FastAPI framework.
+Home-page: https://github.com/stac-utils/stac-fastapi
+Author: Arturo Engineering
+Author-email: engineering@arturo.ai
+License: MIT
+Keywords: STAC FastAPI COG
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: attrs
+Requires-Dist: pydantic[dotenv]<2
+Requires-Dist: stac_pydantic==2.0.*
+Requires-Dist: stac-fastapi.types
+Requires-Dist: stac-fastapi.api
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: requests; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: pdocs; extra == "docs"

{stac-fastapi.extensions-2.4.8 → stac_fastapi_extensions-2.5.0}/setup.py

@@ -7,7 +7,7 @@ with open("README.md") as f:
 
 install_requires = [
     "attrs",
-    "pydantic[dotenv]",
+    "pydantic[dotenv]<2",
     "stac_pydantic==2.0.*",
     "stac-fastapi.types",
     "stac-fastapi.api",
@@ -36,6 +36,10 @@ setup(
         "Intended Audience :: Information Technology",
         "Intended Audience :: Science/Research",
         "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
         "License :: OSI Approved :: MIT License",
     ],
     keywords="STAC FastAPI COG",

{stac-fastapi.extensions-2.4.8 → stac_fastapi_extensions-2.5.0}/stac_fastapi/extensions/core/context.py

@@ -1,4 +1,6 @@
 """Context extension."""
+
+import warnings
 from typing import List, Optional
 
 import attr
@@ -24,6 +26,14 @@ class ContextExtension(ApiExtension):
         default="https://raw.githubusercontent.com/stac-api-extensions/context/v1.0.0-rc.2/json-schema/schema.json"
     )
 
+    def __attrs_post_init__(self):
+        """init."""
+        warnings.warm(
+            "The ContextExtension is deprecated and will be removed in 3.0.",
+            DeprecationWarning,
+            stacklevel=1,
+        )
+
     def register(self, app: FastAPI) -> None:
         """Register the extension with a FastAPI application.
 

{stac-fastapi.extensions-2.4.8 → stac_fastapi_extensions-2.5.0}/stac_fastapi/extensions/core/fields/fields.py

@@ -32,7 +32,7 @@ class FieldsExtension(ApiExtension):
     POST = FieldsExtensionPostRequest
 
     conformance_classes: List[str] = attr.ib(
-        factory=lambda: ["https://api.stacspec.org/v1.0.0-rc.3/item-search#fields"]
+        factory=lambda: ["https://api.stacspec.org/v1.0.0/item-search#fields"]
     )
     default_includes: Set[str] = attr.ib(
         factory=lambda: {

{stac-fastapi.extensions-2.4.8 → stac_fastapi_extensions-2.5.0}/stac_fastapi/extensions/core/filter/filter.py

@@ -57,7 +57,7 @@ class FilterExtension(ApiExtension):
         GET /queryables
         GET /collections/{collection_id}/queryables
 
-    https://github.com/radiantearth/stac-api-spec/blob/master/fragments/filter/README.md
+    https://github.com/stac-api-extensions/filter/blob/main/README.md
 
     Attributes:
         client: Queryables endpoint logic
@@ -76,6 +76,7 @@ class FilterExtension(ApiExtension):
             FilterConformanceClasses.FEATURES_FILTER,
             FilterConformanceClasses.ITEM_SEARCH_FILTER,
             FilterConformanceClasses.BASIC_CQL2,
+            FilterConformanceClasses.CQL2_JSON,
             FilterConformanceClasses.CQL2_TEXT,
         ]
     )

{stac-fastapi.extensions-2.4.8 → stac_fastapi_extensions-2.5.0}/stac_fastapi/extensions/core/query/query.py

@@ -23,7 +23,7 @@ class QueryExtension(ApiExtension):
     POST = QueryExtensionPostRequest
 
     conformance_classes: List[str] = attr.ib(
-        factory=lambda: ["https://api.stacspec.org/v1.0.0-rc.2/item-search#query"]
+        factory=lambda: ["https://api.stacspec.org/v1.0.0/item-search#query"]
     )
     schema_href: Optional[str] = attr.ib(default=None)
 

{stac-fastapi.extensions-2.4.8 → stac_fastapi_extensions-2.5.0}/stac_fastapi/extensions/core/sort/sort.py

@@ -22,7 +22,7 @@ class SortExtension(ApiExtension):
     POST = SortExtensionPostRequest
 
     conformance_classes: List[str] = attr.ib(
-        factory=lambda: ["https://api.stacspec.org/v1.0.0-rc.2/item-search#sort"]
+        factory=lambda: ["https://api.stacspec.org/v1.0.0/item-search#sort"]
     )
     schema_href: Optional[str] = attr.ib(default=None)
 

{stac-fastapi.extensions-2.4.8 → stac_fastapi_extensions-2.5.0}/stac_fastapi/extensions/core/transaction.py

@@ -1,4 +1,5 @@
 """Transaction extension."""
+
 from typing import List, Optional, Type, Union
 
 import attr
@@ -53,8 +54,7 @@ class TransactionExtension(ApiExtension):
     settings: ApiSettings = attr.ib()
     conformance_classes: List[str] = attr.ib(
         factory=lambda: [
-            "https://api.stacspec.org/v1.0.0-rc.2/ogcapi-features/extensions/transaction",
-            "http://www.opengis.net/spec/ogcapi-features-4/1.0/conf/simpletx",
+            "https://api.stacspec.org/v1.0.0-rc.3/ogcapi-features/extensions/transaction",
         ]
     )
     schema_href: Optional[str] = attr.ib(default=None)
@@ -118,10 +118,10 @@ class TransactionExtension(ApiExtension):
         )
 
     def register_update_collection(self):
-        """Register update collection endpoint (PUT /collections)."""
+        """Register update collection endpoint (PUT /collections/{collection_id})."""
         self.router.add_api_route(
             name="Update Collection",
-            path="/collections",
+            path="/collections/{collection_id}",
             response_model=Collection if self.settings.enable_response_models else None,
             response_class=self.response_class,
             response_model_exclude_unset=True,

{stac-fastapi.extensions-2.4.8 → stac_fastapi_extensions-2.5.0}/stac_fastapi/extensions/third_party/bulk_transactions.py

@@ -1,5 +1,6 @@
 """Bulk transactions extension."""
 import abc
+from enum import Enum
 from typing import Any, Dict, List, Optional, Union
 
 import attr
@@ -11,10 +12,18 @@ from stac_fastapi.api.routes import create_async_endpoint
 from stac_fastapi.types.extension import ApiExtension
 
 
+class BulkTransactionMethod(str, Enum):
+    """Bulk Transaction Methods."""
+
+    INSERT = "insert"
+    UPSERT = "upsert"
+
+
 class Items(BaseModel):
     """A group of STAC Item objects, in the form of a dictionary from Item.id -> Item."""
 
     items: Dict[str, Any]
+    method: BulkTransactionMethod = BulkTransactionMethod.INSERT
 
     def __iter__(self):
         """Return an iterable of STAC Item objects."""
@@ -36,7 +45,10 @@ class BaseBulkTransactionsClient(abc.ABC):
 
     @abc.abstractmethod
     def bulk_item_insert(
-        self, items: Items, chunk_size: Optional[int] = None, **kwargs
+        self,
+        items: Items,
+        chunk_size: Optional[int] = None,
+        **kwargs,
     ) -> str:
         """Bulk creation of items.
 
@@ -55,7 +67,11 @@ class AsyncBaseBulkTransactionsClient(abc.ABC):
     """BulkTransactionsClient."""
 
     @abc.abstractmethod
-    async def bulk_item_insert(self, items: Items, **kwargs) -> str:
+    async def bulk_item_insert(
+        self,
+        items: Items,
+        **kwargs,
+    ) -> str:
         """Bulk creation of items.
 
         Args:
@@ -77,11 +93,19 @@ class BulkTransactionExtension(ApiExtension):
     attribute  "items", that has a value that is an object with a group of
     attributes that are the ids of each Item, and the value is the Item entity.
 
+    Optionally, clients can specify a "method" attribute that is either "insert"
+    or "upsert". If "insert", then the items will be inserted if they do not
+    exist, and an error will be returned if they do. If "upsert", then the items
+    will be inserted if they do not exist, and updated if they do. This defaults
+    to "insert".
+
         {
-        "items": {
-            "id1": { "type": "Feature", ... },
-            "id2": { "type": "Feature", ... },
-            "id3": { "type": "Feature", ... }
+            "items": {
+                "id1": { "type": "Feature", ... },
+                "id2": { "type": "Feature", ... },
+                "id3": { "type": "Feature", ... }
+            },
+            "method": "insert"
         }
     """
 

{stac-fastapi.extensions-2.4.8 → stac_fastapi_extensions-2.5.0}/stac_fastapi/extensions/version.py

@@ -1,2 +1,2 @@
 """Library version."""
-__version__ = "2.4.8"
+__version__ = "2.5.0"

stac_fastapi_extensions-2.5.0/stac_fastapi.extensions.egg-info/PKG-INFO

@@ -0,0 +1,35 @@
+Metadata-Version: 2.1
+Name: stac-fastapi.extensions
+Version: 2.5.0
+Summary: An implementation of STAC API based on the FastAPI framework.
+Home-page: https://github.com/stac-utils/stac-fastapi
+Author: Arturo Engineering
+Author-email: engineering@arturo.ai
+License: MIT
+Keywords: STAC FastAPI COG
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: attrs
+Requires-Dist: pydantic[dotenv]<2
+Requires-Dist: stac_pydantic==2.0.*
+Requires-Dist: stac-fastapi.types
+Requires-Dist: stac-fastapi.api
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: requests; extra == "dev"
+Provides-Extra: docs
+Requires-Dist: mkdocs; extra == "docs"
+Requires-Dist: mkdocs-material; extra == "docs"
+Requires-Dist: pdocs; extra == "docs"

{stac-fastapi.extensions-2.4.8 → stac_fastapi_extensions-2.5.0}/stac_fastapi.extensions.egg-info/SOURCES.txt

@@ -28,4 +28,5 @@ stac_fastapi/extensions/core/sort/__init__.py
 stac_fastapi/extensions/core/sort/request.py
 stac_fastapi/extensions/core/sort/sort.py
 stac_fastapi/extensions/third_party/__init__.py
-stac_fastapi/extensions/third_party/bulk_transactions.py
+stac_fastapi/extensions/third_party/bulk_transactions.py
+tests/test_transaction.py

{stac-fastapi.extensions-2.4.8 → stac_fastapi_extensions-2.5.0}/stac_fastapi.extensions.egg-info/requires.txt

@@ -1,5 +1,5 @@
 attrs
-pydantic[dotenv]
+pydantic[dotenv]<2
 stac_pydantic==2.0.*
 stac-fastapi.types
 stac-fastapi.api

stac_fastapi_extensions-2.5.0/tests/test_transaction.py

@@ -0,0 +1,121 @@
+import json
+from typing import Iterator, Union
+
+import pytest
+from starlette.testclient import TestClient
+
+from stac_fastapi.api.app import StacApi
+from stac_fastapi.extensions.core import TransactionExtension
+from stac_fastapi.types.config import ApiSettings
+from stac_fastapi.types.core import BaseCoreClient, BaseTransactionsClient
+from stac_fastapi.types.stac import Item, ItemCollection
+
+
+class DummyCoreClient(BaseCoreClient):
+    def all_collections(self, *args, **kwargs):
+        raise NotImplementedError
+
+    def get_collection(self, *args, **kwargs):
+        raise NotImplementedError
+
+    def get_item(self, *args, **kwargs):
+        raise NotImplementedError
+
+    def get_search(self, *args, **kwargs):
+        raise NotImplementedError
+
+    def post_search(self, *args, **kwargs):
+        raise NotImplementedError
+
+    def item_collection(self, *args, **kwargs):
+        raise NotImplementedError
+
+
+class DummyTransactionsClient(BaseTransactionsClient):
+    """Defines a pattern for implementing the STAC transaction extension."""
+
+    def create_item(self, item: Union[Item, ItemCollection], *args, **kwargs):
+        return {"created": True, "type": item["type"]}
+
+    def update_item(self, *args, **kwargs):
+        raise NotImplementedError
+
+    def delete_item(self, *args, **kwargs):
+        raise NotImplementedError
+
+    def create_collection(self, *args, **kwargs):
+        raise NotImplementedError
+
+    def update_collection(self, *args, **kwargs):
+        raise NotImplementedError
+
+    def delete_collection(self, *args, **kwargs):
+        raise NotImplementedError
+
+
+def test_create_item(client: TestClient, item: Item) -> None:
+    response = client.post("/collections/a-collection/items", content=json.dumps(item))
+    assert response.is_success, response.text
+    assert response.json()["type"] == "Feature"
+
+
+def test_create_item_collection(
+    client: TestClient, item_collection: ItemCollection
+) -> None:
+    response = client.post(
+        "/collections/a-collection/items", content=json.dumps(item_collection)
+    )
+    assert response.is_success, response.text
+    assert response.json()["type"] == "FeatureCollection"
+
+
+@pytest.fixture
+def client(
+    core_client: DummyCoreClient, transactions_client: DummyTransactionsClient
+) -> Iterator[TestClient]:
+    settings = ApiSettings()
+    api = StacApi(
+        settings=settings,
+        client=core_client,
+        extensions=[
+            TransactionExtension(client=transactions_client, settings=settings),
+        ],
+    )
+    with TestClient(api.app) as client:
+        yield client
+
+
+@pytest.fixture
+def core_client() -> DummyCoreClient:
+    return DummyCoreClient()
+
+
+@pytest.fixture
+def transactions_client() -> DummyTransactionsClient:
+    return DummyTransactionsClient()
+
+
+@pytest.fixture
+def item_collection(item: Item) -> ItemCollection:
+    return {
+        "type": "FeatureCollection",
+        "features": [item],
+        "links": [],
+        "context": None,
+    }
+
+
+@pytest.fixture
+def item() -> Item:
+    return {
+        "type": "Feature",
+        "stac_version": "1.0.0",
+        "stac_extensions": [],
+        "id": "test_item",
+        "geometry": {"type": "Point", "coordinates": [-105, 40]},
+        "bbox": [-105, 40, -105, 40],
+        "properties": {},
+        "links": [],
+        "assets": {},
+        "collection": "test_collection",
+    }

stac-fastapi.extensions-2.4.8/PKG-INFO

@@ -1,18 +0,0 @@
-Metadata-Version: 2.1
-Name: stac-fastapi.extensions
-Version: 2.4.8
-Summary: An implementation of STAC API based on the FastAPI framework.
-Home-page: https://github.com/stac-utils/stac-fastapi
-Author: Arturo Engineering
-Author-email: engineering@arturo.ai
-License: MIT
-Keywords: STAC FastAPI COG
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Information Technology
-Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3.8
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Provides-Extra: dev
-Provides-Extra: docs

stac-fastapi.extensions-2.4.8/stac_fastapi.extensions.egg-info/PKG-INFO

@@ -1,18 +0,0 @@
-Metadata-Version: 2.1
-Name: stac-fastapi.extensions
-Version: 2.4.8
-Summary: An implementation of STAC API based on the FastAPI framework.
-Home-page: https://github.com/stac-utils/stac-fastapi
-Author: Arturo Engineering
-Author-email: engineering@arturo.ai
-License: MIT
-Keywords: STAC FastAPI COG
-Classifier: Intended Audience :: Developers
-Classifier: Intended Audience :: Information Technology
-Classifier: Intended Audience :: Science/Research
-Classifier: Programming Language :: Python :: 3.8
-Classifier: License :: OSI Approved :: MIT License
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-Provides-Extra: dev
-Provides-Extra: docs