Merge pull request #21 from Enapter/rnovatorov/dev

Support Platform API v3

Author: rnovatorov

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+        python: ["3.11", "3.12", "3.13", "3.14"]
     steps:
       - name: Checkout
         uses: actions/checkout@v2

.isort.cfg

@@ -1,2 +1,3 @@
 [settings]
 known_first_party=enapter
+profile=black

Makefile

@@ -29,7 +29,9 @@ lint-pyflakes:
 
 .PHONY: lint-mypy
 lint-mypy:
-	pipenv run mypy enapter
+	pipenv run mypy setup.py
+	pipenv run mypy tests
+	pipenv run mypy src/enapter
 
 .PHONY: test
 test: run-unit-tests run-integration-tests
@@ -69,7 +71,7 @@ bump-version:
 ifndef V
 	$(error V is not defined)
 endif
-	sed -E -i 's/__version__ = "[0-9]+.[0-9]+.[0-9]+"/__version__ = "$(V)"/g' enapter/__init__.py
+	sed -E -i 's/__version__ = "[0-9]+.[0-9]+.[0-9]+"/__version__ = "$(V)"/g' src/enapter/__init__.py
 
 	grep -E --files-with-matches --recursive 'enapter==[0-9]+.[0-9]+.[0-9]+' examples \
 		| xargs -n 1 sed -E -i 's/enapter==[0-9]+.[0-9]+.[0-9]+/enapter==$(V)/g'

Pipfile

@@ -18,3 +18,5 @@ pytest-asyncio = "*"
 pytest-cov = "*"
 setuptools = "*"
 twine = "*"
+types-docker = "*"
+types-setuptools = "*"

README.md

@@ -6,89 +6,48 @@
 
 Enapter software development kit for Python.
 
+## Features
+
+- [Standalone
+  Devices](https://v3.developers.enapter.com/docs/standalone/introduction)
+  framework.
+- [MQTT
+  API](https://v3.developers.enapter.com/reference/device_integration/mqtt_api/)
+  client.
+- [HTTP API](https://v3.developers.enapter.com/reference/http/intro) client.
+
 ## Installation
 
-This project uses [semantic versioning](https://semver.org/).
+> [!IMPORTANT]
+> Make sure you are using Python 3.11+.
 
-The API is still under development and may change at any time. It is
-recommended to pin the version during installation.
+> [!WARNING]
+> The API is still under development and may change at any time. It is
+> recommended to pin the version during installation.
 
-Latest from PyPI:
+From PyPI:
 
 ```bash
-pip install enapter==0.11.3
+pip install enapter==0.12.0
 ```
 
 ## Usage
 
-Checkout [examples](examples).
-
-## Implementing your own VUCM
-
-### Device Telemetry and Properties
-
-Every method of `enapter.vucm.Device` subclass decorated with
-`enapter.vucm.device_task` decorator is considered a _device task_. When such a
-device is started, all of its tasks are started as well. Device tasks are
-started in random order and are being executed concurrently in the background.
-If a device task returns or raises an exception, device routine is terminated.
-A typical use of the task is to run a periodic job to send device telemetry and
-properties.
-
-In order to send telemetry and properties define two corresponding device
-tasks. It is advised (but is not obligatory) to send telemetry every **1
-second** and to send properties every **10 seconds**.
-
-Examples:
-
-- [wttr-in](examples/vucm/wttr-in)
-
-### Device Command Handlers
-
-Every method of `enapter.vucm.Device` subclass decorated with
-`enapter.vucm.device_command` is considered a _device command handler_. Device
-command handlers receive the same arguments as described in device Blueprint
-manifest and can optionally return a payload as `enapter.types.JSON`.
-
-In order to handle device commands define corresponding device command
-handlers.
-
-Examples:
+Check out examples:
 
-- [zhimi-fan-za5](examples/vucm/zhimi-fan-za5)
+- [Standalone Devices](examples/standalone)
+- [MQTT API](examples/mqtt)
+- [HTTP API](examples/http)
 
-### Device Alerts
+They provide a good overview of available features and should give you enough
+power to get started.
 
-Device alerts are stored in `self.alerts`. It is a usual Python `set`, so you
-can add an alert using `alerts.add`, remove an alert `alerts.remove` and clear
-alerts using `alerts.clear`.
+> [!TIP]
+> Don't hesitate to peek into the source code - it is supposed to be easy to
+> follow.
 
-Alerts are sent only as part of telemetry, so in order to report device alert,
-use `send_telemetry` with any payload.
+## Help
 
-## Running your own VUCM via Docker
-
-A simple Dockerfile can be:
-
-```
-FROM python:3.10-alpine3.16
-
-WORKDIR /app
-
-RUN python -m venv .venv
-COPY requirements.txt requirements.txt
-RUN .venv/bin/pip install -r requirements.txt
-
-COPY script.py script.py
-
-CMD [".venv/bin/python", "script.py"]
-```
-
-:information_source: If you are using [Enapter
-Gateway](https://handbook.enapter.com/software/gateway_software/) and running
-Linux, you should connect your containers to `host` network
-:information_source::
-
-```bash
-docker run --network host ...
-```
+If you feel lost or confused, reach us in
+[Discord](https://discord.com/invite/TCaEZs3qpe) or just [file a
+bug](https://github.com/Enapter/python-sdk/issues/new). We'd be glad to help.