feat: add stapi-pydantic (#6)

* feat: add stapi-pydantic

* fix: mypy

* fix: unused import

* fix: runs-on

* feat: add concurrency

* fix; uv run mypy

Author: gadomski

.github/workflows/ci.yaml

@@ -0,0 +1,25 @@
+name: "Continuous integration"
+
+concurrency:
+  group: ${{ github.ref }}
+  cancel-in-progress: false
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  ci:
+    name: Continuous integration
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+      - name: Sync
+        run: uv sync
+      - name: Lint
+        run: scripts/lint
+      - name: Test
+        run: uv run pytest

.python-version

@@ -0,0 +1 @@
+3.12

pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "pystapi"
+version = "0.0.0" # This package should never be released, only the workspace members should be
+description = "Monorepo for Satellite Tasking API (STAPI) Specification Python packages"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "stapi-pydantic"
+]
+
+[dependency-groups]
+dev = [
+    "mypy>=1.15.0",
+    "pytest>=8.3.5",
+    "ruff>=0.11.2",
+]
+
+[tool.uv.workspace]
+members = ["stapi-pydantic"]
+
+[tool.uv.sources]
+stapi-pydantic.workspace = true
+
+[tool.mypy]
+strict = true
+files = "stapi-pydantic/src/stapi_pydantic/**/*.py"

scripts/format

@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+
+uv run ruff check --fix
+uv run ruff format

scripts/lint

@@ -0,0 +1,6 @@
+
+#!/usr/bin/env sh
+
+uv run ruff check
+uv run ruff format --check
+uv run mypy

stapi-pydantic/README.md

@@ -0,0 +1,21 @@
+[project]
+name = "stapi-pydantic"
+version = "0.0.1"
+description = "Pydantic models for Satellite Tasking API (STAPI) Specification"
+readme = "README.md"
+authors = [
+    { name = "Phil Varner", email = "[email protected]" },
+    { name = "Pete Gadomski", email = "[email protected]" },
+]
+requires-python = ">=3.10"
+dependencies = [
+    "cql2>=0.3.6",
+    "geojson-pydantic>=1.2.0",
+]
+
+[project.scripts]
+stapi-pydantic = "stapi_pydantic:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

stapi-pydantic/pyproject.toml

@@ -0,0 +1,11 @@
+from .opportunity import OpportunityProperties
+from .product import Product, Provider, ProviderRole
+from .shared import Link
+
+__all__ = [
+    "Link",
+    "OpportunityProperties",
+    "Product",
+    "Provider",
+    "ProviderRole",
+]

stapi-pydantic/src/stapi_pydantic/__init__.py

@@ -0,0 +1,11 @@
+from pydantic import BaseModel, Field
+
+CORE = "https://stapi.example.com/v0.1.0/core"
+OPPORTUNITIES = "https://stapi.example.com/v0.1.0/opportunities"
+ASYNC_OPPORTUNITIES = "https://stapi.example.com/v0.1.0/async-opportunities"
+
+
+class Conformance(BaseModel):
+    conforms_to: list[str] = Field(
+        default_factory=list, serialization_alias="conformsTo"
+    )

stapi-pydantic/src/stapi_pydantic/conformance.py

@@ -0,0 +1,5 @@
+from pydantic import BaseModel, ConfigDict
+
+
+class Constraints(BaseModel):
+    model_config = ConfigDict(extra="allow")