Merge pull request #1 from Botts-Innovative-Research/dev

v 0.1

Author: tipatterson-dev

.github/workflows/docs_pages.yaml

@@ -0,0 +1,35 @@
+name: Docs2Pages
+on:
+  push:
+    tags: '*'
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build-docs:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@master
+      with:
+        fetch-depth: 0
+    - uses: actions/setup-python@v2
+      with:
+        python-version: 3.9
+    - uses: abatilo/actions-poetry@v2.1.3
+    - name: install
+      run: poetry install -E amazon -E docs
+    - name: Build documentation
+      run: |
+        mkdir gh-pages
+        touch gh-pages/.nojekyll
+        cd docs/
+        poetry run sphinx-build -b html . _build
+        cp -r _build/* ../gh-pages/
+    - name: Deploy documentation
+      if: ${{ github.event_name == 'push' }}
+      uses: JamesIves/github-pages-deploy-action@4.1.4
+      with:
+        branch: gh-pages
+        folder: gh-pages

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,31 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'OSHConnect-Python'
+copyright = '2024, Ian Patterson'
+author = 'Ian Patterson'
+release = '0.1'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+
+extensions = [
+    'sphinx.ext.doctest',
+    'sphinx.ext.duration',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+]
+templates_path = ['_templates']
+exclude_patterns = []
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+html_static_path = ['_static']

docs/source/index.rst

@@ -0,0 +1,36 @@
+.. OSHConnect-Python documentation master file, created by
+   sphinx-quickstart on Tue Jun 25 11:43:33 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to OSHConnect-Python's documentation!
+=============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
+OSHConnect-Python
+=================
+OSHConnect-Python is the Python version of the OSHConnect family of application libraries inteded to provide a simple
+and straightforward way to interact with OpenSensorHub (or another CSAPI server) by way of OGC API - Connected Systems.
+It supports or will support at the time of a 1.0 release Part 1 and Part 2 of the Connected Systems api, as well as
+certain streaming features made possible by OpenSensorHub.
+
+OSHConnect
+==========
+
+.. automodule:: oshconnect
+    :members:
+    :undoc-members:
+    :show-inheritance:

external_models/__init__.py

@@ -0,0 +1,131 @@
+#   ==============================================================================
+#   Copyright (c) 2024 Botts Innovative Research, Inc.
+#   Date:  2024/5/31
+#   Author:  Ian Patterson
+#   Contact Email:  ian@botts-inc.com
+#   ==============================================================================
+from __future__ import annotations
+
+from typing import Any
+
+from pydantic import BaseModel, ConfigDict, Field, field_validator, model_validator
+from shapely import Point
+from typing_extensions import Self
+
+
+class BoundingBox(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    lower_left_corner: Point = Field(..., description="The lower left corner of the bounding box.")
+    upper_right_corner: Point = Field(..., description="The upper right corner of the bounding box.")
+    min_value: float = Field(None, description="The minimum value of the bounding box.")
+    max_value: float = Field(None, description="The maximum value of the bounding box.")
+
+    # @model_validator(mode='before')
+    # def validate_minmax(self) -> Self:
+    #     if self.min_value > self.max_value:
+    #         raise ValueError("min_value must be less than max_value")
+    #     return self
+
+
+class DateTime(BaseModel):
+    is_instant: bool = Field(True, description="Whether the date time is an instant or a period.")
+    iso_date: str = Field(None, description="The ISO formatted date time.")
+    time_period: tuple = Field(None, description="The time period of the date time.")
+
+    @model_validator(mode='before')
+    def valid_datetime_type(self) -> Self:
+        if self.is_instant:
+            if self.iso_date is None:
+                raise ValueError("Instant date time must have a valid ISO8601 date.")
+        return self
+
+    @field_validator('iso_date')
+    @classmethod
+    def check_iso_date(cls, v) -> str:
+        if not v:
+            raise ValueError("Instant date time must have a valid ISO8601 date.")
+        return v
+
+
+class TimePeriod(BaseModel):
+    start: str = Field(...)
+    end: str = Field(...)
+
+    @model_validator(mode='before')
+    @classmethod
+    def valid_time_period(cls, data) -> Any:
+        if isinstance(data, list):
+            if data[0] > data[1]:
+                raise ValueError("Time period start must be before end.")
+            return {"start": data[0], "end": data[1]}
+        elif isinstance(data, dict):
+            if data['start'] > data['end']:
+                raise ValueError("Time period start must be before end.")
+            return data
+
+    def __repr__(self):
+        return f'{[self.start, self.end]}'
+
+    def does_timeperiod_overlap(self, checked_timeperiod: TimePeriod) -> bool:
+        if checked_timeperiod.start < self.end and checked_timeperiod.end > self.start:
+            return True
+        else:
+            return False
+
+
+
+class SecurityConstraints:
+    constraints: list
+
+
+class LegalConstraints:
+    constraints: list
+
+
+class Characteristics:
+    characteristics: list
+
+
+class Capabilities:
+    capabilities: list
+
+
+class Contact:
+    contact: list
+
+
+class Documentation:
+    documentation: list
+
+
+class HistoryEvent:
+    history_event: list
+
+
+class ConfigurationSettings:
+    settings: list
+
+
+class FeatureOfInterest:
+    feature: list
+
+
+class Input:
+    input: list
+
+
+class Output:
+    output: list
+
+
+class Parameter:
+    parameter: list
+
+
+class Mode:
+    mode: list
+
+
+class ProcessMethod:
+    method: list

external_models/object_models.py

@@ -0,0 +1,84 @@
+#   ==============================================================================
+#   Copyright (c) 2024 Botts Innovative Research, Inc.
+#   Date:  2024/5/31
+#   Author:  Ian Patterson
+#   Contact Email:  ian@botts-inc.com
+#   ==============================================================================
+import uuid
+from typing import List
+
+from conSys4Py import DatastreamSchema
+from conSys4Py.datamodels.api_utils import Link
+from pydantic import BaseModel, ConfigDict, Field
+from shapely import Geometry
+
+from external_models import BoundingBox, Capabilities, Characteristics, ConfigurationSettings, Contact, DateTime, \
+    Documentation, \
+    FeatureOfInterest, HistoryEvent, Input, LegalConstraints, \
+    Mode, Output, Parameter, ProcessMethod, SecurityConstraints, TimePeriod
+
+
+class System(BaseModel):
+    model_config = ConfigDict(arbitrary_types_allowed=True)
+
+    feature_type: str = Field(None, serialization_alias="type")
+    system_id: str = Field(None, serialization_alias="id")
+    properties: dict = Field(None)
+    geometry: Geometry | None = Field(None)
+    bbox: BoundingBox = Field(None)
+    links: List[Link] = Field(None)
+    description: str = Field(None)
+    uid: uuid.UUID = Field(None)
+    label: str = Field(None)
+    lang: str = Field(None)
+    keywords: List[str] = Field(None)
+    identifiers: List[str] = Field(None)
+    classifiers: List[str] = Field(None)
+    valid_time: DateTime = Field(None, serialization_alias="validTime")
+    security_constraints: List[SecurityConstraints] = Field(None, serialization_alias="securityConstraints")
+    legal_constraints: List[LegalConstraints] = Field(None, serialization_alias="legalConstraints")
+    characteristics: List[Characteristics] = Field(None)
+    capabilities: List[Capabilities] = Field(None)
+    contacts: List[Contact] = Field(None)
+    documentation: List[Documentation] = Field(None)
+    history: List[HistoryEvent] = Field(None)
+    definition: str = Field(None)
+    type_of: str = Field(None, serialization_alias="typeOf")
+    configuration: ConfigurationSettings = Field(None)
+    features_of_interest: List[FeatureOfInterest] = Field(None, alias="featuresOfInterest")
+    inputs: List[Input] = Field(None)
+    outputs: List[Output] = Field(None)
+    parameters: List[Parameter] = Field(None)
+    modes: List[Mode] = Field(None)
+    method: ProcessMethod = Field(None)
+
+
+class DatastreamResource(BaseModel):
+    # model_config = ConfigDict(populate_by_name=True)
+
+    ds_id: str = Field(..., alias="id")
+    name: str = Field(...)
+    description: str = Field(None)
+    valid_time: TimePeriod = Field(..., alias="validTime")
+    output_name: str = Field(None, alias="outputName")
+    procedure_link: Link = Field(None, alias="procedureLink@link")
+    deployment_link: Link = Field(None, alias="deploymentLink@link")
+    ultimate_feature_of_interest_link: Link = Field(None, alias="ultimateFeatureOfInterest@link")
+    sampling_feature_link: Link = Field(None, alias="samplingFeature@link")
+    parameters: dict = Field(None)
+    phenomenon_time: TimePeriod = Field(None, alias="phenomenonTimeInterval")
+    result_time: TimePeriod = Field(None, alias="resultTimeInterval")
+    ds_type: str = Field(None, alias="type")
+    result_type: str = Field(None, alias="resultType")
+    links: List[Link] = Field(None)
+    schema: DatastreamSchema = Field(None)
+
+
+class Observation(BaseModel):
+    sampling_feature_id: str = Field(None, serialization_alias="samplingFeature@Id")
+    procedure_link: Link = Field(None, serialization_alias="procedure@link")
+    phenomenon_time: DateTime = Field(None, serialization_alias="phenomenonTime")
+    result_time: DateTime = Field(..., serialization_alias="resultTime")
+    parameters: dict = Field(None)
+    result: dict = Field(...)
+    result_link: Link = Field(None, serialization_alias="result@link")