Create dev branch

Author: kennymc-c

.github/workflows/build.yml

@@ -0,0 +1,116 @@
+# Manual triggered GitHub action to build a self-contained binary of the Requests Python driver and attach it to a release draft including a hash file
+---
+name: "Build & Draft Release"
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - dev
+
+env:
+  INTG_NAME: requests
+  HASH_FILENAME: intg-requests.hash
+  # Python version to use in the builder image. See https://hub.docker.com/r/unfoldedcircle/r2-pyinstaller for possible versions.
+  PYTHON_VER: 3.11.6-0.2.0
+
+jobs:
+  build:
+    name: Build Release
+    runs-on: ubuntu-latest
+    #Save version to env output variable to be able to use it in the following release job as a tag
+    outputs:
+      version: ${{ steps.get-version.outputs.VERSION }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          # History of 200 should be more than enough to calculate commit count since last release tag
+          fetch-depth: 200
+          # Only for testing. Delete when merging with main branch
+          ref: dev 
+
+      - name: Get version
+        #Needed for env output variable
+        id: get-version
+        run: |
+          echo "VERSION=$(jq .version -r driver.json)" >> $GITHUB_ENV
+          # Save to Github output to later use it in Create Release job
+          echo "VERSION=$(jq .version -r driver.json)" >> $GITHUB_OUTPUT
+
+      - name: Build
+        run: |
+          sudo apt-get update && sudo apt-get install -y qemu binfmt-support qemu-user-static
+          docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
+          echo "Starting pyinstaller build"
+          docker run --rm --name builder \
+            --platform=aarch64 \
+            --user=$(id -u):$(id -g) \
+            -v ${GITHUB_WORKSPACE}:/workspace \
+            docker.io/unfoldedcircle/r2-pyinstaller:${PYTHON_VER} \
+            bash -c \
+            "cd /workspace && \
+              python -m pip install -r requirements.txt && \
+              pyinstaller --clean --onefile --name intg-${INTG_NAME} --collect-all zeroconf intg-${INTG_NAME}/driver.py"
+
+      - name: Add version
+        run: |
+          mkdir -p artifacts
+          cd artifacts
+          echo ${{ env.VERSION }} > version.txt
+
+      - name: Prepare artifacts
+        shell: bash
+        run: |
+          cp dist/intg-${INTG_NAME} artifacts/
+          cp driver.json artifacts/
+          echo "ARTIFACT_NAME=uc-intg-${{ env.INTG_NAME }}-${{ env.VERSION }}-aarch64" >> $GITHUB_ENV
+          
+      - name: Create upload artifact archive
+        shell: bash
+        run: | 
+          tar czvf ${{ env.ARTIFACT_NAME }}.tar.gz -C ${GITHUB_WORKSPACE}/artifacts .
+          ls -lah
+          
+      - uses: actions/upload-artifact@v4
+        id: upload_artifact
+        with:
+          name: ${{ env.ARTIFACT_NAME }}
+          path: ${{ env.ARTIFACT_NAME }}.tar.gz
+          if-no-files-found: error
+          retention-days: 3
+            
+  release:
+    name: Create Release
+    runs-on: ubuntu-latest
+    needs: [build]
+    permissions:
+      contents: write
+
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+
+      - name: Extract build archives from downloaded files
+        run: |
+          ls -R
+          # extract tar.gz build archives from downloaded artifacts
+          # (wrapped in tar from actions/upload-artifact, then extracted into a directory by actions/download-artifact)
+          for D in * 
+            do if [ -d "${D}" ]; then
+              mv $D/* ./
+            fi
+          done;
+
+      - name: Create hash file
+        run: |
+          for filename in *.tar.gz; do echo "sha256  `sha256sum $filename`" >> ${{ env.HASH_FILENAME }}; done;
+
+      - name: Create release draft
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: "*.tar.gz,${{ env.HASH_FILENAME }}"
+          draft: true
+          generateReleaseNotes: true
+          artifactErrorsFailBuild: true
+          tag: v${{needs.build.outputs.version}}

.pylintrc

@@ -0,0 +1,29 @@
+[FORMAT]
+
+# Maximum number of characters on a single line.
+max-line-length=175
+
+[MESSAGES CONTROL]
+
+# Disable the message, report, category or checker with the given id(s). You
+# can either give multiple identifiers separated by comma (,) or put this
+# option multiple times (only on the command line, not in the configuration
+# file where it should appear only once).You can also use "--disable=all" to
+# disable everything first and then re-enable specific checks. For example, if
+# you want to run only the similarities checker, you can use "--disable=all
+# --enable=similarities". If you want to run only the classes checker, but have
+# no Warning level messages displayed, use"--disable=all --enable=classes
+# --disable=W"
+
+disable=
+    global-statement,
+    too-many-instance-attributes,
+    too-many-arguments,
+    too-many-public-methods,
+    fixme # temporary
+
+[STRING]
+
+# This flag controls whether inconsistent-quotes generates a warning when the
+# character used as a quote delimiter is used inconsistently within a module.
+check-quote-consistency=yes

CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+*Changes in the next release*
+
+### Breaking changes
+- The configuration json file is now created in the root of the repository. Existing users have to move the config.json file from the intg-requests directory
+- The working directory when starting driver.py should now be the root of the repository. The path in docker-entry.sh has been adjusted.
+- In preparation to the upcoming custom integration upload feature setup.json has been renamed to driver.json and moved to the root of the repository to adapt to the official UC integrations
+ 
+### Added
+- The wake-on-lan entity now supports an ipv4/v6 address or a hostname (ipv4 only) as a parameter
+  - Discover the mac address from an ip address or a hostname may not work on all systems. Please refer to the [getmac supported platforms](https://github.com/GhostofGoes/getmac?tab=readme-ov-file#platforms-currently-supported). Docker containers need to be run in the host network (`--net=host`)
+- Add build.yml Github action to automatically build a self-contained binary of the integration and create a release draft with the current driver version as a tag/name
+
+### Changed
+- Corrected the semantic version scheme in driver.json (x.x to x.x.x)
+
+
+
 ## [0.2-beta] - 2024-06-26
 
 ### Breaking changes
@@ -16,11 +33,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added a more granular http status code response handling
 - Added optional parameter to send form data in the request body as key/value pairs (see README)
-- Added optional custom global entity-independent timeout and ssl verify option in the integration setup. For self signed ssl certificates to work the ssl verify option needs to be deactivated.
+- Added optional custom global entity-independent timeout and ssl verify options in the integration setup. For self signed ssl certificates to work the ssl verify option needs to be deactivated.
 
 ### Changed
 - Only return an error response to the remote if the http response code is in the 400 or 500 range. Otherwise display the status code in the integration log if it's not 200/Ok
 
+
+
 ## [0.1-beta] - 2024-04-27
 
 ### Added

README.md

@@ -8,27 +8,27 @@
 
 Integration for Unfolded Circle [Remote Two](https://www.unfoldedcircle.com/remote-two) and [Remote 3](https://www.unfoldedcircle.com) running [Unfolded OS](https://www.unfoldedcircle.com/unfolded-os) to send network requests to a specified url or mac address.
 
-Using [uc-integration-api](https://github.com/aitatoi/integration-python-library), [requests](https://github.com/psf/requests) and [pywakeonlan](https://github.com/remcohaszing/pywakeonlan).
+Using [uc-integration-api](https://github.com/aitatoi/integration-python-library), [requests](https://github.com/psf/requests), [pywakeonlan](https://github.com/remcohaszing/pywakeonlan) and [getmac](https://github.com/GhostofGoes/getmac).
 
 
 ### Supported features
 
 - Send http(s) get, post, patch & put requests to a specified url
-  - Set a custom timeout and deactivate ssl certificate verification
-- Send Wake on LAN magic packets to a specified mac address
+  - Define a global custom timeout and deactivate ssl certificate verification during the integration setup
+- Send Wake on LAN magic packets to a specified mac address, ip (v4/v6) or hostname (ipv4 only)
+  - Discover the mac address from an ip address or a hostname may not work on all systems. Please refer to the [getmac supported platforms](https://github.com/GhostofGoes/getmac?tab=readme-ov-file#platforms-currently-supported)
 
 
 ### Planned features
 
-- Send Wake on LAN magic packets by entering the ip address
-- Support for sending json and xml data in request body
+- Support for sending json and xml data in the request body
 
 *Planned improvements are labeled with #TODO in the code*
 
 
 ## Configuration
 
-During the integration setup you can change the default http request timeout of 2 seconds to a custom value. You also can deactivate the ssl certificate verification. This is needed for self signed certificates. You can run the setup process again in the integration settings after adding entities to the remote.
+During the integration setup you can change the default http request timeout of 2 seconds to a custom value. You also can deactivate the ssl certificate verification. This is needed for self signed ssl certificates. You can run the setup process again in the integration settings to change these settings after adding entities to the remote.
 
 ## Usage
 
@@ -43,27 +43,41 @@ Optional form data in the request body as key/value pairs can be added with a pa
 Note that if your url contains a paragraph character you need to url-encode it first (%C2%A7, see https://www.urlencoder.io)
 
 
-### Setup
+## Installation
 
-#### Requirements
+### Run on the remote
 
-- Python 3.10 or newer
+#### Download integration
+
+Download the tar.gz archive in the assets section from the [latest release](https://github.com/kennymc-c/ucr2-integration-requests/releases/latest)
+
+#### Upload to the remote
+
+TBA
+
+### Run as an external integration on a separate server
+
+#### Bare metal/VM
+
+##### Requirements
+
+- Python 3.11
 - Install Libraries:  
   (using a [virtual environment](https://docs.python.org/3/library/venv.html) is highly recommended)
 
 ```shell
 pip3 install -r requirements.txt
 ```
 
-### Run
+##### Start the integration
 
 ```shell
 python3 intg-requests/driver.py
 ```
 
-### Run as a Docker container
+#### Docker container
 
-For the mDNS advertisement to work correctly it's advised to start the integration in the host network (`--net=host`). You can also set the websocket listening port with the environment variable `UC_INTEGRATION_HTTP_PORT`, set the listening interface with `UC_INTEGRATION_INTERFACE` or change the default debug log level with `UC_LOG_LEVEL`. See available [environment variables](https://github.com/unfoldedcircle/integration-python-library#environment-variables)
+For the mDNS advertisement (auto discovery of the integration) to work correctly and to be able to use wake-on-lan with an ip address or a hostname instead of a mac address the integration needs to be run in the host network (`--net=host`). You can also set the websocket listening port with the environment variable `UC_INTEGRATION_HTTP_PORT`, set the listening interface with `UC_INTEGRATION_INTERFACE` or change the default debug log level with `UC_LOG_LEVEL`. See available [environment variables](https://github.com/unfoldedcircle/integration-python-library#environment-variables)
 in the Python integration library.
 
 All data is mounted to `/usr/src/app`:

config.json

@@ -0,0 +1 @@
+{"setup_complete": true}

docker-entry.sh

@@ -1,5 +1,5 @@
 #!/bin/bash
 
-pip install --no-cache-dir -q -r /usr/src/app/requirements.txt
-cd /usr/src/app/intg-requests
-python driver.py
+cd /usr/src/app
+pip install --no-cache-dir -q -r requirements.txt
+python intg-requests/driver.py

intg-requests/setup.json renamed to driver.json

@@ -1,6 +1,6 @@
 {
   "driver_id": "requests",
-  "version": "0.2",
+  "version": "0.2.0",
   "release_date": "2024-06-26",
   "min_core_api": "0.24.3",
   "name": {