async-httpd-data-collector 2.0.1__tar.gz → 2.0.2__tar.gz

async_httpd_data_collector-2.0.1/.github/workflows/publish-pypi.yml → async_httpd_data_collector-2.0.2/.github/workflows/publish.yml

@@ -1,38 +1,55 @@
-name: Publish Python Package
+---
+# Builds, relases and publishes to PyPi
+# .github/workflows/publish.yml
+name: CD
+
+# triggered when testing is finished
 on:
-  push:
-    branches:
-      - master
-    tags:
-      - 'v*'
+  workflow_run:
+    workflows: ["CI"]
+    branches: [master]
+    types:
+      - completed
+
+# add contents: write for the release
+permissions:
+  contents: write
+
 jobs:
-  build-and-publish:
+
+  build-release-publish:
     runs-on: ubuntu-latest
+
     steps:
+
       - name: Checkout repository
         uses: actions/checkout@v2
+
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
           python-version: '3.x'
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install build twine
           pip install -r requirements.txt
+
       - name: Build the application
         run: |
           python -m build
-      - name: Publish to PyPi
-        if: startsWith(github.ref, 'refs/tags/')
-        env:
-          TWINE_USERNAME: __token__
-          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
-        run: |
-          python -m twine upload dist/*
+
       - name: Release
         uses: softprops/action-gh-release@v2
         if: startsWith(github.ref, 'refs/tags/')
         with:
           files: |
-            dist/*
+            dist/**
+
+      - name: Publish to PyPi
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: |-
+          python -m twine upload dist/*

{async_httpd_data_collector-2.0.1 → async_httpd_data_collector-2.0.2}/.github/workflows/test.yml

@@ -1,12 +1,20 @@
-name: Python CI
-# publish on push to master
+---
+# Workflow sets up the database and tests the project.
+# .github/workflows/test.yml
+
+name: CI
+
+# trigger on push to the master
 on:
   push:
     branches:
       - master
+
 jobs:
-  deploy:
+  continuous-integration:
     runs-on: ubuntu-latest
+
+    # set up influxdb database and flask server
     services:
       influxdb:
         image: influxdb:2
@@ -16,24 +24,30 @@ jobs:
         image: python:3.9
         ports:
           - 5000:5000
+
     steps:
-      - name: Check out repository
+
+      - name: Checkout repository
         uses: actions/checkout@v2
+
+      # install InfluxDB CLI to authenticate access to the database
       - name: Install InfluxDB CLI
         run: |
           wget https://download.influxdata.com/influxdb/releases/influxdb2-client-2.7.5-linux-amd64.tar.gz
           tar xvzf ./influxdb2-client-2.7.5-linux-amd64.tar.gz
-          sudo cp ./influx /usr/local/bin/
+          cp ./influx /usr/local/bin/
+
       - name: Set up InfluxDB
         id: setup-influx
         run: |
-          # passes to test database with no data
+
+          # default auth data for the test instance
           INFLUX_USERNAME="test-user"
           INFLUX_PASSWORD="test-password"
           INFLUX_ORG="test-org"
           INFLUX_BUCKET="test-bucket"
 
-          # setting up the database
+          # setting up the test instance
           influx setup \
             --username "$INFLUX_USERNAME" \
             --password "$INFLUX_PASSWORD" \
@@ -41,13 +55,14 @@ jobs:
             --bucket "$INFLUX_BUCKET" \
             --force
 
-          # saving information required for connection later
+          # save the data required for the token generation and testing
           echo "::set-output name=org::${INFLUX_ORG}"
           echo "::set-output name=bucket::${INFLUX_BUCKET}"
-      - name: Authorization for InfluxDB
+
+      - name: Generate token for further authentication
         id: auth
         run: |
-          # authenticating the connection
+
           INFLUX_TOKEN=$(influx auth create \
             --user "$INFLUX_USERNAME" \
             --org "$INFLUX_ORG" \
@@ -56,31 +71,33 @@ jobs:
             --skip-verify \
             --json | jq '.token')
 
-          # saving the token for the connection
+          # save the token
           echo "::set-output name=token::${INFLUX_TOKEN}"
+
       - name: Set up Python
         uses: actions/setup-python@v2
         with:
           python-version: '3.11'
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install build
-          pip install ruff
-          pip install twine
+          pip install ruff build twine
           pip install -r requirements.txt
-      - name: Lint with ruff
+
+      - name: Check formatting
         run: |
-          ruff format
           ruff check
-      - name: Test with pytest
-        run: |
-          # starting the flask server, supplying some sample data
+
+      - name: Test
+        run: |-
+
+          # run the falsk dev_server
           export FLASK_APP="tests/dev_server"
           flask run --host=0.0.0.0 --port=9000 &
           sleep 5
 
-          # setting the connection variables as for the pytest to use
+          # exporting data required for testing as env variables
           export PYTHONPATH="$PYTHONPATH:$(pwd)"
           export INFLUXDB_HOST="localhost"
           export INFLUXDB_PORT=8086

async_httpd_data_collector-2.0.2/.yamlfmt.yml

@@ -0,0 +1,6 @@
+---
+formatter:
+  type: basic
+  trim_trailing_whitespace: true
+  retain_line_breaks: true
+  include_document_start: true

async_httpd_data_collector-2.0.2/.yamllint.yml

@@ -0,0 +1,7 @@
+---
+extends: default
+
+rules:
+  line-length:
+    max: 80
+    level: warning

{async_httpd_data_collector-2.0.1 → async_httpd_data_collector-2.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: async-httpd-data-collector
-Version: 2.0.1
+Version: 2.0.2
 Summary: Gateway facilitating asyncronous communication between sensory data-emitting devices, InfluxDB and the user.
 Project-URL: Repository, https://github.com/straightchlorine/async-httpd-data-collector
 Project-URL: Issues, https://github.com/straightchlorine/async-httpd-data-collector/issues

async_httpd_data_collector-2.0.2/ahttpdc/__init__.py

@@ -0,0 +1 @@
+__version__ = 'v2.0.2'

{async_httpd_data_collector-2.0.1 → async_httpd_data_collector-2.0.2}/ahttpdc/read/database_interface.py

@@ -51,7 +51,7 @@ class DatabaseInterface:
         db_org: str,
         db_bucket: str,
         srv_ip: str,
-        srv_port: int | str = 8000,
+        srv_port: int | str = 80,
         handle: str = '',
         interval: int = 1,
     ):

{async_httpd_data_collector-2.0.1 → async_httpd_data_collector-2.0.2}/ahttpdc/read/fetch/fetcher.py

@@ -60,7 +60,7 @@ class AsyncFetcher:
                     print(f'Error fetching data: {response.status}')
                 else:
                     # TODO: Add some verification module to check if the JSON response is
-                    # appropriate for further processing, i.e. it follows:
+                    # appropriate for further processing.
 
                     read = await response.json()
                     return read

{async_httpd_data_collector-2.0.1 → async_httpd_data_collector-2.0.2}/tests/read/query/test_query.py

@@ -111,7 +111,7 @@ class TestAsyncQuery:
 
         # wait for some data to flow in
         self.set_up()
-        await asyncio.sleep(2)
+        await asyncio.sleep(5)
         self.daemon.disable()
 
         result = await self.query.latest()

{async_httpd_data_collector-2.0.1 → async_httpd_data_collector-2.0.2}/tests/read/test_interface.py

@@ -80,7 +80,7 @@ class TestInterface:
         """
 
         self.set_up()
-        await asyncio.sleep(1)
+        await asyncio.sleep(5)
         self.interface.daemon.disable()
 
         assert True

async_httpd_data_collector-2.0.1/ahttpdc/__init__.py

@@ -1 +0,0 @@
-__version__ = 'v2.0.1'