add mongo folder

Author: jonhealy1

stac_fastpi/mongo/README.md

@@ -0,0 +1,3 @@
+# Requirements
+
+The Mongo backend requires **mongodb**.

stac_fastpi/mongo/pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+testpaths = tests
+addopts = -sv

stac_fastpi/mongo/setup.cfg

@@ -0,0 +1,2 @@
+[metadata]
+version = attr: stac_fastapi.mongo.version.__version__

stac_fastpi/mongo/setup.py

@@ -0,0 +1,56 @@
+"""stac_fastapi: mongo module."""
+
+from setuptools import find_namespace_packages, setup
+
+with open("README.md") as f:
+    desc = f.read()
+
+install_requires = [
+    "attrs",
+    "pydantic[dotenv]",
+    "stac_pydantic==2.0.*",
+    "stac-fastapi.types",
+    "stac-fastapi.api",
+    "stac-fastapi.extensions",
+    "fastapi-utils",
+    "pymongo",
+]
+
+extra_reqs = {
+    "dev": [
+        "pytest",
+        "pytest-cov",
+        "pytest-asyncio",
+        "pre-commit",
+        "requests",
+    ],
+    "docs": ["mkdocs", "mkdocs-material", "pdocs"],
+    "server": ["uvicorn[standard]>=0.12.0,<0.14.0"],
+}
+
+
+setup(
+    name="stac-fastapi.mongo",
+    description="An implementation of STAC API based on the FastAPI framework.",
+    long_description=desc,
+    long_description_content_type="text/markdown",
+    python_requires=">=3.8",
+    classifiers=[
+        "Intended Audience :: Developers",
+        "Intended Audience :: Information Technology",
+        "Intended Audience :: Science/Research",
+        "Programming Language :: Python :: 3.8",
+        "License :: OSI Approved :: MIT License",
+    ],
+    keywords="STAC FastAPI COG",
+    author=u"Arturo Engineering",
+    author_email="engineering@arturo.ai",
+    url="https://github.com/stac-utils/stac-fastapi",
+    license="MIT",
+    packages=find_namespace_packages(exclude=["alembic", "tests", "scripts"]),
+    zip_safe=False,
+    install_requires=install_requires,
+    tests_require=extra_reqs["dev"],
+    extras_require=extra_reqs,
+    entry_points={"console_scripts": ["stac-fastapi-mongo=stac_fastapi.mongo.app:run"]},
+)

stac_fastpi/mongo/stac_fastapi/mongo/__init__.py

@@ -0,0 +1 @@
+"""mongo submodule."""

stac_fastpi/mongo/stac_fastapi/mongo/app.py

@@ -0,0 +1,73 @@
+"""FastAPI application."""
+from stac_fastapi.api.app import StacApi
+from stac_fastapi.api.models import create_get_request_model, create_post_request_model
+from stac_fastapi.extensions.core import (
+    ContextExtension,
+    FieldsExtension,
+    SortExtension,
+    TokenPaginationExtension,
+    TransactionExtension,
+)
+from stac_fastapi.extensions.third_party import BulkTransactionExtension
+from stac_fastapi.mongo.config import MongoSettings
+from stac_fastapi.mongo.core import CoreCrudClient
+from stac_fastapi.mongo.extensions import QueryExtension
+from stac_fastapi.mongo.session import Session
+from stac_fastapi.mongo.transactions import BulkTransactionsClient, TransactionsClient
+
+settings = MongoSettings()
+session = Session.create_from_settings(settings)
+
+extensions = [
+    TransactionExtension(client=TransactionsClient(session=session), settings=settings),
+    BulkTransactionExtension(client=BulkTransactionsClient(session=session)),
+    FieldsExtension(),
+    QueryExtension(),
+    SortExtension(),
+    TokenPaginationExtension(),
+    ContextExtension(),
+]
+
+post_request_model = create_post_request_model(extensions)
+
+api = StacApi(
+    settings=settings,
+    extensions=extensions,
+    client=CoreCrudClient(session=session, post_request_model=post_request_model),
+    search_get_request_model=create_get_request_model(extensions),
+    search_post_request_model=post_request_model,
+)
+app = api.app
+
+
+def run():
+    """Run app from command line using uvicorn if available."""
+    try:
+        import uvicorn
+
+        uvicorn.run(
+            "stac_fastapi.mongo.app:app",
+            host=settings.app_host,
+            port=settings.app_port,
+            log_level="info",
+            reload=settings.reload,
+        )
+    except ImportError:
+        raise RuntimeError("Uvicorn must be installed in order to use command")
+
+
+if __name__ == "__main__":
+    run()
+
+
+def create_handler(app):
+    """Create a handler to use with AWS Lambda if mangum available."""
+    try:
+        from mangum import Mangum
+
+        return Mangum(app)
+    except ImportError:
+        return None
+
+
+handler = create_handler(app)

stac_fastpi/mongo/stac_fastapi/mongo/config.py

@@ -0,0 +1,47 @@
+"""API configuration."""
+import os
+from typing import Set
+
+from pymongo import GEO2D, GEOSPHERE, MongoClient, errors
+
+from stac_fastapi.types.config import ApiSettings
+
+DOMAIN = os.getenv("MONGO_HOST")
+PORT = os.getenv("MONGO_PORT")
+
+
+class MongoSettings(ApiSettings):
+    """API settings."""
+
+    # Fields which are defined by STAC but not included in the database model
+    forbidden_fields: Set[str] = {"type"}
+
+    # Fields which are item properties but indexed as distinct fields in the database model
+    indexed_fields: Set[str] = {"datetime"}
+
+    @property
+    def create_client(self):
+        """Create mongo client."""
+        try:
+            client = MongoClient(
+                host=[str(DOMAIN) + ":" + str(PORT)],
+                serverSelectionTimeoutMS=3000,
+                username=os.getenv("MONGO_USER"),
+                password=os.getenv("MONGO_PASS"),
+            )
+
+            # create indices - they are only created if they don't already exist
+            item_table = client.stac.stac_item
+            item_table.create_index([("bbox", GEOSPHERE), ("properties.datetime", 1)])
+            item_table.create_index([("geometry", GEOSPHERE)])
+            item_table.create_index([("properties.datetime", 1)])
+            item_table.create_index([("properties.created", 1)])
+            item_table.create_index([("properties.updated", 1)])
+            item_table.create_index([("bbox", GEOSPHERE)])
+            item_table.create_index([("bbox", GEO2D)])
+
+        except errors.ServerSelectionTimeoutError as err:
+            client = None
+            print("pymongo ERROR:", err)
+
+        return client