Feature/cleanup packaging (#50)

* fix license in pyproject.toml

* add temporary script (before creating GH action)

* src is not a package

* add variants of venv to .gitignore

* revert most of 382f374

* move agrirouter/ to src/agrirouter/

* remove all imports from root __init__ for a clean start

* re-add agrirouter package reference to test imports

* fix some reverting issues

* fix imports in tests

* fix import path

* fix header encoding for Python >= 3.8

* fix imports and linting

* add Python 3.12 to linting and add internal tests to CI

* add manual trigger for integration tests, including version selection

* also need to install requirements, module alone is not enough

* remove upper Python version boundary

* explicitly list client side requirements

* update flake8 version in requirements

* clean up some requirements

* clean up some requirements

* clean up some requirements

* final requirements fix :)

* ignore E721 (type checking) for flake8

* add JUnit-style test output & report

* beautify check names for test reports

Author: oliverrahner

.github/workflows/continuous-integration.yml

@@ -6,6 +6,12 @@ name: Continuous Integration
 on:
   push:
     branches: [ main ]
+  workflow_dispatch:
+    inputs:
+      python-version:
+        description: 'Python versions'
+        required: true
+        default: '["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]'
 
 jobs:
   build:
@@ -15,7 +21,7 @@ jobs:
       max-parallel: 1
       fail-fast: false
       matrix:
-        python-version: [ "3.11" ]
+        python-version: ${{ github.event_name == 'push' && '3.11' || fromJson(github.event.inputs.python-version) }}
 
     steps:
       - uses: actions/checkout@v4
@@ -27,12 +33,21 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pip install -e .
       - name: Lint with flake8
         run: |
           flake8 .
       - name: Test with pytest
         run: |
-          pytest
+          pytest --junitxml=junit/test-results.xml
       - name: Dry run building the wheel
         run: |
           python -m build --sdist --wheel
+      - name: Publish Test Report
+        uses: mikepenz/action-junit-report@v4
+        if: success() || failure()
+        with:
+          check_name: "Test Report (${{ matrix.python-version }})"
+          report_paths: 'junit/test-results.xml'
+          detailed_summary: true
+          include_passed: true

.github/workflows/linting-for-all-versions.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
 
-name: Continuous Integration
+name: Linting & Internal tests for all versions
 
 on:
   push:
@@ -17,7 +17,7 @@ jobs:
       max-parallel: 1
       fail-fast: false
       matrix:
-        python-version: [ "3.7","3.8", "3.9", "3.10", "3.11" ]
+        python-version: [ "3.7","3.8", "3.9", "3.10", "3.11", "3.12" ]
 
     steps:
       - uses: actions/checkout@v4
@@ -29,9 +29,21 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+          pip install -e .
       - name: Lint with flake8
         run: |
           flake8 .
+      - name: Run internal tests
+        run: |
+          pytest tests/agrirouter/internal --junitxml=junit/test-results.xml
       - name: Dry run building the wheel
         run: |
           python -m build --sdist --wheel
+      - name: Publish Test Report
+        uses: mikepenz/action-junit-report@v4
+        if: success() || failure()
+        with:
+          check_name: "Test Report (${{ matrix.python-version }})"
+          report_paths: 'junit/test-results.xml'
+          detailed_summary: true
+          include_passed: true

.gitignore

@@ -1,6 +1,10 @@
 build
 dist
+
 venv
+env
+virtualenv
+
 .idea
 **/__pycache__
 *.egg-info
@@ -10,6 +14,5 @@ venv
 .pytest_cache
 /paho/
 /paho_mqtt-1.6.1.dist-info/
-agrirouter.egg-info/
-build/
-dist/
+/paho/
+/paho_mqtt-1.6.1.dist-info/

README.md

@@ -1,4 +1,4 @@
-![agrirouter logo](./assets/images/agrirouter.svg)
+<img src="https://files.my-agrirouter.com/agrirouter_logo.svg" height="100" />
 
 # About the project
 

example_script.py

@@ -1,10 +1,16 @@
 import time
+import agrirouter as ar
+from agrirouter.onboarding.enums import Gateways
+from agrirouter.generated.messaging.request.payload.endpoint.subscription_pb2 import Subscription
+from agrirouter.generated.messaging.request.payload.endpoint.capabilities_pb2 import CapabilitySpecification
+from agrirouter.messaging.services.commons import HttpMessagingService, MqttMessagingService
+from agrirouter.utils.uuid_util import new_uuid
 
 from google.protobuf.timestamp_pb2 import Timestamp
 
-from src.agrirouter.generated.messaging.request.payload.account.endpoints_pb2 import ListEndpointsQuery
-from src.agrirouter.generated.messaging.request.payload.feed.feed_requests_pb2 import ValidityPeriod
-from src.agrirouter.onboarding.response import OnboardResponse
+from agrirouter.generated.messaging.request.payload.account.endpoints_pb2 import ListEndpointsQuery
+from agrirouter.generated.messaging.request.payload.feed.feed_requests_pb2 import ValidityPeriod
+from agrirouter.onboarding.response import OnboardResponse
 
 public_key = """-----BEGIN PUBLIC KEY-----
 MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAzGt41/+kSOTlO1sJvLIN
@@ -64,15 +70,6 @@
     }
 }
 
-import src as ar
-from src.agrirouter.onboarding.enums import Gateways
-from src.agrirouter.api.enums import CapabilityType
-from src.agrirouter.generated.messaging.request.payload.endpoint.subscription_pb2 import Subscription
-from src.agrirouter.generated.messaging.request.payload.endpoint.capabilities_pb2 import CapabilitySpecification
-from src.agrirouter.messaging.services.commons import HttpMessagingService, MqttMessagingService
-from src import ListEndpointsParameters, ListEndpointsService, SubscriptionService, SubscriptionParameters, \
-    QueryHeaderService, QueryHeaderParameters, CapabilitiesService, CapabilitiesParameters
-from src.agrirouter.utils.uuid_util import new_uuid
 
 application_id = "8c947a45-c57d-42d2-affc-206e21d63a50"  # # store here your application id. You can find it in AR UI
 certification_version_id = "edd5d6b7-45bb-4471-898e-ff9c2a7bf56f"  # # store here your certification version id. You can find it in AR UI
@@ -298,9 +295,9 @@ def example_query_header_message_mqtt(onboarding_response_data, on_msg_callback)
 def on_message_callback(client, userdata, msg):
     # Define here the way receiving messages will be processed
 
-    from src.agrirouter.messaging.decode import decode_response
-    from src.agrirouter.messaging.decode import decode_details
-    from src.agrirouter.messaging.messages import OutboxMessage
+    from agrirouter.messaging.decode import decode_response
+    from agrirouter.messaging.decode import decode_details
+    from agrirouter.messaging.messages import OutboxMessage
 
     outbox_message = OutboxMessage()
     outbox_message.json_deserialize(msg.payload.decode().replace("'", '"'))

examples.txt

@@ -1,26 +1,31 @@
 [project]
 name = "agrirouter"
-version = "2.0.0"
+version = "2.0.0b1"
 description = "Python SDK for the agrirouter API. This project contains the API for the communication with the agrirouter. Everything you need for the onboarding process, secure communication and much more."
 authors = [
     { name = "Alexey Petrovsky", email = "petrovsky.lexey@gmail.com" },
     { name = "Oliver Rahner", email = "o.rahner@dke-data.com" },
     { name = "Sascha Dömer", email = "Cf4ThQgxcnxAovOUXTNv@saschadoemer.de" },
 ]
 readme = "README.md"
-requires-python = ">=3.7, <=3.11"
+requires-python = ">=3.7" # no upper boundary according to https://discuss.python.org/t/requires-python-upper-limits/12663
 urls = { "Source" = "https://github.com/DKE-Data/agrirouter-sdk-python" }
 classifiers = [
     "Intended Audience :: Developers",
-    "License :: Apache License 2.0",
+    "License :: OSI Approved :: Apache Software License",
     "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
     "Topic :: Software Development :: Libraries",
     "Topic :: Software Development :: Libraries :: Python Modules"
 ]
+dependencies = [
+    "requests",
+    "protobuf~=3.18.0"
+]
 
 [build-system]
 requires = ["setuptools", "wheel"]

pyproject.toml

@@ -1,17 +1,15 @@
-pytest==6.2.5
-black==21.9b0
-flake8==3.9.2
-pyflakes==2.3.1
+
+pytest~=8.1.1; python_version >= "3.8"
+pytest~=7.4.4; python_version <= "3.7"
+build~=1.2.1; python_version >= "3.8"
+build~=0.10.0; python_version <= "3.7"
+flake8~=7.0.0; python_version >= "3.8"
+flake8~=5.0.4; python_version <= "3.7"
+
 cryptography~=3.4.8
 setuptools~=68.0.0
-pycparser~=2.20
-idna~=3.2
-urllib3~=1.26.18
-certifi~=2023.7.22
 requests~=2.31.0
 paho-mqtt~=1.5.1
 protobuf~=3.18.0
 google~=3.0.0
 toml~=0.10.2
-build~=1.1.1
-importlib-metadata<5.0

src/__init__.py requirements-dev.txtsrc/__init__.py renamed to requirements-dev.txt

@@ -20,6 +20,11 @@ class ContentTypes(BaseEnum):
     APPLICATION_JSON = "application/json"
 
 
+class Environments(BaseEnum):
+    PRODUCTION: str = "production"
+    QA: str = "qa"
+
+
 class RequestHeaders(BaseEnum):
     AUTHORIZATION: str = "Authorization"
     X_AGRIROUTER_SIGNATURE: str = "X-Agrirouter-Signature"