chore: wip

Author: jeafreezy

README.md

@@ -1,2 +1,31 @@
 # SuperSTAC
+
 a Python library designed for high-availability satellite imagery retrieval. If one data source lacks the requested imagery, DeepEO seamlessly queries alternative sources until it finds a valid result.
+
+
+# Dependencies
+
+- pystac-client.
+
+
+### Configuration YML
+
+Template:
+
+```
+catalogs:
+  Catalog Name:
+    url: Catalog URL
+    auth:
+      type: bearer
+      token: "YOUR_MICROSOFT_PC_TOKEN"
+  Catalog Name:
+    url: Catalog URL
+    type: basic
+      username: youruser
+      password: yourpass
+```
+
+# Todo - auth configuration documentation.
+
+See [.superstac.yml](./superstac/.superstac.yml) for an example configuration file.

pyproject.toml

@@ -5,3 +5,8 @@ description = "Add your description here"
 readme = "README.md"
 requires-python = ">=3.9"
 dependencies = []
+
+[tool.uv]
+dev-dependencies = [
+    "ruff",
+]

ruff.toml

@@ -0,0 +1,2 @@
+[lint]
+select = ["ALL"]

superstac/.superstac.yml

@@ -0,0 +1,5 @@
+catalogs:
+  Earth Search:
+    url: https://earth-search.aws.element84.com/v1
+  Planetary Computer:
+    url: https://planetarycomputer.microsoft.com/api/stac/v1

superstac/__init__.py

@@ -0,0 +1 @@
+class CatalogManager: ...

superstac/catalog.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+
+class AuthType(str, Enum):
+    BEARER = "bearer"
+    BASIC = "basic"
+    API_KEY = "apikey"

superstac/enums.py

@@ -0,0 +1,45 @@
+"""SuperSTAC Models."""
+
+from __future__ import annotations
+
+from typing import Optional
+from urllib.parse import urlparse
+
+import attr
+
+from superstac.enums import AuthType
+
+
+@attr.s(auto_attribs=True, kw_only=True)
+class AuthInfo:
+    type: AuthType
+    token: Optional[str] | None = None
+    username: Optional[str] = None
+    password: Optional[str] | None = None
+    header_key: Optional[str] | None = None
+
+
+@attr.s(auto_attribs=True, kw_only=True)
+class CatalogEntry:
+    """_summary_.
+
+    Raises:
+        ValueError: _description_
+
+    """
+
+    name: str
+    url: str = attr.ib(validator=attr.validators.instance_of(str))
+    auth: Optional[AuthInfo] = None
+    is_available: bool = False
+    latency_ms: Optional[float] = None
+    conforms_to: Optional[list[str]] = None
+    collections: Optional[list[str]] = None
+    extensions: Optional[list[str]] = None
+
+    @url.validator
+    def _validate_url(self, _, value) -> None:
+        result = urlparse(value)
+        if not result.scheme.startswith("http"):
+            msg = "Invalid URL: must start with http or https"
+            raise ValueError(msg)