Merge pull request #28 from Botts-Innovative-Research/mqtt

MQTT Obs and Commands basics

Author: tipatterson-dev

.github/workflows/docs_pages.yaml

@@ -1,34 +1,33 @@
 name: Docs2Pages
-on: [push, pull_request, workflow_dispatch]
+on: [ push, pull_request, workflow_dispatch ]
 permissions:
   contents: write
 
 jobs:
   build-docs:
     runs-on: ubuntu-latest
     steps:
-    - name: Checkout
-      uses: actions/checkout@v3
-    - uses: actions/setup-python@v5
-      with:
-        python-version: '3.12'
+      - name: Checkout
+        uses: actions/checkout@v5
 
-    - name: Install Poetry
-      uses: snok/install-poetry@v1
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
 
-    - name: Install dependencies
-      run: |
-        poetry install --with dev
+      - name: Install Python 3.13
+        run: uv python install 3.13
 
-    - name: Sphinx build
-      run: |
-        poetry run sphinx-build -b html docs/source docs/build/html
+      - name: Install dependencies
+        run: uv sync --all-extras
 
-    - name: Deploy documentation
-      uses: peaceiris/actions-gh-pages@v4
-      if: github.event_name == 'push' && github.ref == 'refs/heads/main'
-      with:
-        publish_branch: gh-pages
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: ./docs/build/html
-        force_orphan: true
+      - name: Sphinx build
+        run: |
+          uv run sphinx-build -b html docs/source docs/build/html
+
+      - name: Deploy documentation
+        uses: peaceiris/actions-gh-pages@v4
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/build/html
+          force_orphan: true

.github/workflows/linting.yaml

@@ -4,17 +4,18 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v5
-        with:
-          python-version: '3.12'
+      - name: Checkout
+        uses: actions/checkout@v5
 
-      - name: Install Poetry
-        uses: snok/install-poetry@v1
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install Python 3.13
+        run: uv python install 3.13
 
       - name: Install dependencies
-        run: |
-          poetry install --with dev
+        run: uv sync --all-extras
+
       - name: Lint
         run: |
-          poetry run flake8
+          uv run flake8 src/oshconnect

.github/workflows/publish.yml

@@ -0,0 +1,27 @@
+name: publish.yml
+on:
+  push:
+    tags:
+      # publishes any tag starting with 'v' as in 'v1.0'
+      - v*
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    environment:
+      name: publish
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+      - name: Install Python 3.13
+        run: uv python install 3.13
+      - name: Build
+        run: uv build
+        # Need to add a test that verifies the builds
+      - name: Publish
+        run: uv publish

docs/source/tutorial.rst

@@ -156,7 +156,7 @@ datastream schemas.
     A TimeSchema is required to be the first field in the DataRecordSchema for OSH.
 
 Inserting an Observation into and OpenSensorHub Node
------------------------------------------
+-----------------------------------------------------
 Upon successfully adding a new datastream to a system, it is now possible to send observation data to the node.
 
 .. code-block:: python