Merge pull request #89 from ngehrsitz/ci

CI + Docker image

Author: githubDante

.github/workflows/black.yml

@@ -0,0 +1,13 @@
+name: Lint
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: psf/black@stable

.github/workflows/docker.yml

@@ -0,0 +1,39 @@
+name: Build and Push Docker Image
+
+on:
+  push:
+
+permissions:
+  contents: read
+  packages: write
+
+env:
+  DOCKER_BUILDKIT: 1
+  IMAGE_NAME: ghcr.io/${{ github.repository }}
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: |
+            ${{ env.IMAGE_NAME }}:${{ github.sha }}
+            ${{ github.ref_name == 'main' && format('{0}:latest', env.IMAGE_NAME) || '' }}

.github/workflows/pytest.yml

@@ -0,0 +1,27 @@
+name: Run Pytest
+
+on: [push, pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install pytest .
+
+      - name: Run Pytest
+        run: |
+          pytest

Dockerfile

@@ -0,0 +1,9 @@
+# syntax=docker/dockerfile:1
+FROM python:3.13-alpine
+
+# mount current directory to /app
+# install with pip
+RUN --mount=type=bind,rw,source=.,target=/src \
+    pip install --no-cache-dir /src
+
+CMD echo "Available commands:" && find /usr/local/bin -type f -name 'solarman*' -exec basename {} \;

README.md

@@ -48,6 +48,12 @@ To install the latest development version from git, run:
 
 This will also install the tools from the [utils](/utils) directory.
 
+## Docker
+
+To run the tools in the docker image, run:
+
+`docker run --rm ghcr.io/jmccrohan/pysolarmanv5:latest`
+
 ## Projects using pysolarmanv5
 
 - [davidrapan/ha-solarman](https://github.com/davidrapan/ha-solarman)

docs/conf.py

@@ -2,22 +2,22 @@
 import sys
 from datetime import date
 
-sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath("../"))
 
-project = 'pysolarmanv5'
+project = "pysolarmanv5"
 copyright = f"{date.today().year}, Jonathan McCrohan"
-author = 'Jonathan McCrohan <jmccrohan@gmail.com>'
+author = "Jonathan McCrohan <jmccrohan@gmail.com>"
 
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosectionlabel',
-    'sphinx.ext.viewcode',
-    'sphinx.ext.todo',
-    'myst_parser',
-    'sphinxcontrib.packetdiag',
-    ]
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.todo",
+    "myst_parser",
+    "sphinxcontrib.packetdiag",
+]
 
-html_theme = 'furo'
+html_theme = "furo"
 
 html_theme_options = {
     "source_repository": "https://github.com/jmccrohan/pysolarmanv5/",
@@ -26,21 +26,21 @@
 }
 
 autodoc_default_options = {
-    'members': True,
-    'member-order': 'bysource',
+    "members": True,
+    "member-order": "bysource",
     #'private-members': True,
-    }
+}
 
 autodoc_mock_imports = ["umodbus"]
 
 autosectionlabel_prefix_document = True
 
-packetdiag_html_image_format = 'SVG'
+packetdiag_html_image_format = "SVG"
 
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 html_css_files = [
-        'css/custom.css',
-        ]
+    "css/custom.css",
+]
 
-#todo_include_todos = True
+# todo_include_todos = True

examples/async_client_example.py

@@ -1,4 +1,5 @@
-""" A basic client demonstrating how to use the async version of pysolarmanv5."""
+"""A basic client demonstrating how to use the async version of pysolarmanv5."""
+
 from pysolarmanv5 import PySolarmanV5Async
 import asyncio
 
@@ -11,7 +12,12 @@ async def main():
     respectively.
     """
     modbus = PySolarmanV5Async(
-        '192.168.1.121', 1234567890, port=8899, mb_slave_id=1, verbose=False, auto_reconnect=True
+        "192.168.1.121",
+        1234567890,
+        port=8899,
+        mb_slave_id=1,
+        verbose=False,
+        auto_reconnect=True,
     )
     await modbus.connect()
 
@@ -27,15 +33,18 @@ async def main():
     """Query single input register, apply scaling, result as a float"""
 
     print(
-        await modbus.read_input_register_formatted(register_addr=33035, quantity=1, scale=0.1)
+        await modbus.read_input_register_formatted(
+            register_addr=33035, quantity=1, scale=0.1
+        )
     )
 
     """Query two input registers, shift first register up by 16 bits, result as a signed int, """
     print(
-        await modbus.read_input_register_formatted(register_addr=33079, quantity=2, signed=1)
+        await modbus.read_input_register_formatted(
+            register_addr=33079, quantity=2, signed=1
+        )
     )
 
-
     """Query single holding register, apply bitmask and bitshift left (extract bit1 from register)"""
     print(
         await modbus.read_holding_register_formatted(
@@ -45,5 +54,6 @@ async def main():
 
     await modbus.disconnect()
 
+
 if __name__ == "__main__":
     asyncio.run(main())

examples/client_example.py

@@ -1,4 +1,5 @@
-""" A basic client demonstrating how to use pysolarmanv5."""
+"""A basic client demonstrating how to use pysolarmanv5."""
+
 from pysolarmanv5 import PySolarmanV5
 
 
@@ -41,5 +42,6 @@ def main():
 
     modbus.disconnect()
 
+
 if __name__ == "__main__":
     main()

examples/register_scan.py

@@ -1,4 +1,5 @@
-""" Scan Modbus registers to find valid registers"""
+"""Scan Modbus registers to find valid registers"""
+
 from pysolarmanv5 import PySolarmanV5, V5FrameError
 import umodbus.exceptions
 

pyproject.toml

@@ -4,13 +4,12 @@ version = "3.0.6"
 description = "A Python library for interacting with Solarman (IGEN-Tech) v5 based Solar Data Loggers"
 readme = "README.md"
 requires-python = ">=3.8"
-license = {text = "MIT License"}
+license = "MIT"
 authors = [{name = "Jonathan McCrohan", email = "jmccrohan@gmail.com"}]
 keywords = ["solarman", "igen-tech", "modbus", "solar", "inverter", "solarmanv5"]
 classifiers = [
     "Programming Language :: Python :: 3",
     "Topic :: Utilities",
-    "License :: OSI Approved :: MIT License",
 ]
 dependencies = [
     "umodbus",