Merge branch 'master' of https://github.com/bullitt186/python-e3dc

.github/workflows/make_wheel.yml

@@ -21,7 +21,7 @@ jobs:
               run: pip install wheel twine
 
             - name: Checkout repository
-              uses: actions/checkout@v3
+              uses: actions/checkout@v4
 
             - name: Build wheel
               run: |

.github/workflows/validate.yml

@@ -7,9 +7,9 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:

.readthedocs.yaml

@@ -7,9 +7,9 @@ version: 2
 
 # Set the version of Python and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: "ubuntu-22.04"
   tools:
-    python: "3.10"
+    python: "3.11"
     # You can also specify other tool versions:
     # nodejs: "19"
     # rust: "1.64"

README.md

@@ -5,19 +5,21 @@
 [![Codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 [![Documentation Status](https://readthedocs.org/projects/python-e3dc/badge/?version=latest)](https://python-e3dc.readthedocs.io/en/latest/?badge=latest)
 
-**NOTE: With Release 0.6.0 at least Python 3.7 is required**
+**NOTE: With Release 0.8.0 at least Python 3.8 is required**
 
 Python API for querying an [E3/DC](https://e3dc.de/) systems
 
 This is supported either directly via RSCP connection or through the manufacturer's portal. The RSCP implementation has currently the most capabilities.
 
 In order to use it you need:
+
 - Your user name
 - Your password
 - The IP address of the E3/DC system
 - The RSCP Password (encryption key), as set on the device under Main Page -> Personalize -> User profile -> RSCP password
 
 Alternatively, for a web connection, you need:
+
 - Your user name
 - Your password
 - The serial number of the system, which can be found when logging into the E3/DC webpage.
@@ -37,7 +39,7 @@ This library assumes, that there is one inverter installed and the root power me
 
 For any other configurations, there is an optional `configuration` object that can be used to alter the defaults:
 
-```
+```python
 {
   "pvis": [
     {
@@ -86,6 +88,7 @@ print(e3dc.get_pvi_data())
 ### poll() return values
 
 Poll returns a dictionary like the following:
+
 ```python
 {
     'autarky': 100,
@@ -107,23 +110,23 @@ Poll returns a dictionary like the following:
 
 ### Available methods
 
-* `poll()`
-* `get_system_info()`
-* `get_system_status()`
-* `poll_switches()`
-* `get_idle_periods()`
-* `set_idle_periods()`
-* `get_db_data()`
-* `get_battery_data()`
-* `get_batteries_data()`
-* `get_pvi_data()`
-* `get_pvis_data()`
-* `get_powermeter_data()`
-* `get_powermeters_data()`
-* `get_power_settings()`
-* `set_power_limits()`
-* `set_powersave()`
-* `set_weather_regulated_charge()`
+- `poll()`
+- `get_system_info()`
+- `get_system_status()`
+- `poll_switches()`
+- `get_idle_periods()`
+- `set_idle_periods()`
+- `get_db_data()`
+- `get_battery_data()`
+- `get_batteries_data()`
+- `get_pvi_data()`
+- `get_pvis_data()`
+- `get_powermeter_data()`
+- `get_powermeters_data()`
+- `get_power_settings()`
+- `set_power_limits()`
+- `set_powersave()`
+- `set_weather_regulated_charge()`
 
 See the full documentation on [ReadTheDocs](https://python-e3dc.readthedocs.io/en/latest/)
 
@@ -162,12 +165,15 @@ One limitation of the package concerns the implemented RSCP methods. This projec
 
 ## Projects using this library
 
-* [e3dc-rest](https://github.com/vchrisb/e3dc-rest): a simple REST API to access an E3/DC system
-* [e3dc-to-mqtt](https://github.com/mdhom/e3dc-to-mqtt): publish E3/DC data via MQTT
+- [e3dc-rest](https://github.com/vchrisb/e3dc-rest): a simple REST API to access an E3/DC system
+- [e3dc-to-mqtt](https://github.com/mdhom/e3dc-to-mqtt): publish E3/DC data via MQTT
+- [weewx-photovoltaics](https://github.com/roe-dl/weewx-photovoltaics): Extension to WeeWX for processing data of the photovoltaics system E3/DC
+- [hacs-e3dc](https://github.com/torbennehmer/hacs-e3dc): HACS Version of the E3DC Home Assistant integration
 
 ## Contribution
 
-* open an issue before making a pull request
-* note the E3/DC system you tested with and implementation details
-* pull request checks will enforce code styling (black, flake8, isort)
-* consider adding yourself to `AUTHORS`
+- Open an issue before making a pull request
+- Note the E3/DC system you tested with and implementation details
+- Pull request checks will enforce code styling (black, flake8, flake8-docstrings, isort)
+- Make sure to support Python versions >= 3.8
+- Consider adding yourself to `AUTHORS`

docs/requirements.txt

@@ -1 +1,2 @@
 sphinx_mdinclude 
+sphinx_rtd_theme

docs/source/conf.py

@@ -6,7 +6,7 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = "e3dc"
+project = "python-e3dc"
 copyright = "2023, see AUTHORS file"
 author = "see AUTHORS file"
 
@@ -20,6 +20,7 @@
     "sphinx.ext.autodoc",
     "sphinx_rtd_theme",
     "sphinx_mdinclude",
+    "sphinx.ext.napoleon",
 ]
 
 templates_path = ["_templates"]
@@ -31,7 +32,7 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
 html_theme = "sphinx_rtd_theme"
-html_static_path = ["_static"]
+# html_static_path = ["_static"]
 
 # -- Options for todo extension ----------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/extensions/todo.html#configuration

docs/source/index.rst

@@ -1,9 +1,9 @@
-.. e3dc documentation master file, created by
+.. python-e3dc documentation master file, created by
    sphinx-quickstart on Sat Feb 11 10:32:00 2023.
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to e3dc's documentation!
+Welcome to python-e3dc's documentation!
 ================================
 
 .. mdinclude:: ../../README.md

e3dc/__init__.py

@@ -25,4 +25,4 @@
     "FrameError",
     "set_rscp_debug",
 ]
-__version__ = "0.7.5"
+__version__ = "0.8.1"