Add basic client #14

dostuffthatmatters · 2023-09-11T20:49:41Z

Moved to #21

Remove dummy data script - this will be located in a separate repository

Add static type pytest

Add github actions workflow to test client for different python versions

cloudflare-workers-and-pages · 2023-09-11T20:50:40Z

Deploying with Cloudflare Pages

Latest commit:	`441b929`
Status:	✅ Deploy successful!
Preview URL:	https://d54d65b8.tenta.pages.dev
Branch Preview URL:	https://development-moritz.tenta.pages.dev

View logs

Debug CI

Start implementing client class

Add example script

Add option to block during message sending

Add more comments to example script

Refactor publish API, add measurement publishing

Add acknowledgement publishing

Make message timestamps configurable

Receive configurations

empicano · 2023-09-12T11:13:42Z

Ping me when it's ready for review 😉

Add script to start an MQTT broker in a docker container This broker has password authentication which cannot be tested with the `test.mosquitto.org` broker

Implement readable error messages on connection failure

Test various connection failures/success

Add `on_config_message` and `on_publish` callbacks Add more comments Refactor client class

Use `connection_timeout` argument to make tests fail faster

Extend example code with callbacks

Write script that converts example code into markdown file

Update example code and conversion script

Use public MQTT broker, debug static types

Add TLS support

Test TLS support in connection tests

Remove unused local mosquitto docker broker

Add TLS to example Improve TLS args docs Rename `revision` parameter to `config_revision` Order pytests (static type tests first)

Add documentation generation

Update documentation Write test that checks whether documentation is up to date

Add test for config receiving

Add mosquitto dependencies to CI workflow

Add publishing test to improve coverage

Convert instance variables to class variables in order to sync the state between threads Update TLS Protocol in Example

Possibly debug race conditions during publishing

dostuffthatmatters · 2023-09-13T03:30:09Z

Hi, @empicano! I think it is ready for review :)

Some comments:

The connection to the broker test.mosquitto.org is tested with an unencrypted instance and with an TLS-exncrypted one. I chose the style of aiomqtt and pass the tls settings directly to paho
I was careful that the only non-optional dependency is paho
client/example.py is copied over to docs/pages/user-guide/python-client-example.mdx and the comments are interpreted as markdown. This way I can check the static types. See https://development-moritz.tenta.pages.dev/user-guide/python-client-example
I used pydoc-markdown to automatically generate the API reference. This generation does not run in the website build-CI because it requires a Python environment which I really don't want to configure in that CI. Hence, there is a pytest that checks whether the generated markdowns (example and API reference) are up to date. See https://development-moritz.tenta.pages.dev/api-reference/python-client-api
I am testing strict static types, connection success and failure with various failure reasons, publishing, and config receiving and it is at 94% coverage now :)

I am looking forward to your comments!

EDIT: I just noticed that only the __init__ docstring is in the Google Docstring format, but the others are not yet. I will update that tomorrow.
EDIT 2: The docstrings are all in Google style now :)

Update docstrings and remove `TentaClient.reset` method

Fix returns in docstrings Add comment about long connection time on wrong ports Add `py.typed` file

Fix typos in client and example code

Restructure `ConfigMessage` and `TLSParameters` class so that they are rendered in the API reference as well

dostuffthatmatters · 2023-09-14T21:11:10Z

@empicano as a reference: https://github.com/thingsboard/thingsboard-python-client-sdk

dostuffthatmatters · 2023-09-15T12:15:02Z

It closed the PR, when I renamed the branch, sorry ^^ I will open a new one at #21

dostuffthatmatters added 3 commits September 11, 2023 22:34

#1 - Implement MQTT client library (5)

b37820f

Remove dummy data script - this will be located in a separate repository

#1 - Implement MQTT client library (6)

fbf236b

Add static type pytest

#1 - Implement MQTT client library (7)

72b323d

Add github actions workflow to test client for different python versions

dostuffthatmatters force-pushed the development-moritz branch 2 times, most recently from 7c2330b to 290c9bd Compare September 11, 2023 21:04

#1 - Implement MQTT client library (8)

7fb87a0

Debug CI

dostuffthatmatters force-pushed the development-moritz branch from 290c9bd to 7fb87a0 Compare September 11, 2023 21:08

dostuffthatmatters added 8 commits September 11, 2023 23:51

#1 - Implement MQTT client library (9)

01c3543

Start implementing client class

#1 - Implement MQTT client library (10)

1f11690

Add example script

#1 - Implement MQTT client library (11)

971d21f

Add option to block during message sending

#1 - Implement MQTT client library (12)

a588fb1

Add more comments to example script

#1 - Implement MQTT client library (13)

6562b77

Refactor publish API, add measurement publishing

#1 - Implement MQTT client library (14)

794899b

Add acknowledgement publishing

#1 - Implement MQTT client library (15)

36cba74

Make message timestamps configurable

#1 - Implement MQTT client library (16)

3bccfc8

Receive configurations

dostuffthatmatters added 13 commits September 12, 2023 22:57

#1 - Implement MQTT client library (17)

02d7f25

Add script to start an MQTT broker in a docker container This broker has password authentication which cannot be tested with the `test.mosquitto.org` broker

#1 - Implement MQTT client library (18)

57f03f6

Implement readable error messages on connection failure

#1 - Implement MQTT client library (19)

4c2037b

Test various connection failures/success

#1 - Implement MQTT client library (20)

f15f525

Add `on_config_message` and `on_publish` callbacks Add more comments Refactor client class

#1 - Implement MQTT client library (21)

79fbee1

Use `connection_timeout` argument to make tests fail faster

#1 - Implement MQTT client library (22)

8c34b46

Extend example code with callbacks

#1 - Implement MQTT client library (23)

b43eebe

Write script that converts example code into markdown file

#1 - Implement MQTT client library (24)

b26ed82

Update example code and conversion script

#1 - Implement MQTT client library (25)

fce26ff

Use public MQTT broker, debug static types

#1 - Implement MQTT client library (26)

76b6634

Add TLS support

#1 - Implement MQTT client library (27)

3816569

Test TLS support in connection tests

#1 - Implement MQTT client library (28)

3851cb4

Remove unused local mosquitto docker broker

#1 - Implement MQTT client library (29)

49b7212

Add TLS to example Improve TLS args docs Rename `revision` parameter to `config_revision` Order pytests (static type tests first)

dostuffthatmatters added 7 commits September 13, 2023 03:14

#1 - Implement MQTT client library (30)

d96d657

Add documentation generation

#1 - Implement MQTT client library (31)

840d72a

Update documentation Write test that checks whether documentation is up to date

#1 - Implement MQTT client library (32)

19a1970

Add test for config receiving

#1 - Implement MQTT client library (33)

f60d8be

Add mosquitto dependencies to CI workflow

#1 - Implement MQTT client library (34)

d59d264

Add publishing test to improve coverage

#1 - Implement MQTT client library (35)

3a5d8cf

Convert instance variables to class variables in order to sync the state between threads Update TLS Protocol in Example

#1 - Implement MQTT client library (36)

747bcb4

Possibly debug race conditions during publishing

dostuffthatmatters requested a review from empicano September 13, 2023 03:30

dostuffthatmatters added 4 commits September 13, 2023 13:17

#1 - Implement MQTT client library (37)

744cde7

Update docstrings and remove `TentaClient.reset` method

#1 - Implement MQTT client library (38)

4fdd7c4

Fix returns in docstrings Add comment about long connection time on wrong ports Add `py.typed` file

#1 - Implement MQTT client library (39)

9fc97c3

Fix typos in client and example code

#1 - Implement MQTT client library (40)

441b929

Restructure `ConfigMessage` and `TLSParameters` class so that they are rendered in the API reference as well

dostuffthatmatters closed this Sep 15, 2023

dostuffthatmatters deleted the development-moritz branch September 15, 2023 12:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add basic client #14

Add basic client #14

dostuffthatmatters commented Sep 11, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Sep 11, 2023 •

edited

Loading

empicano commented Sep 12, 2023

dostuffthatmatters commented Sep 13, 2023 •

edited

Loading

dostuffthatmatters commented Sep 14, 2023

dostuffthatmatters commented Sep 15, 2023 •

edited

Loading

Add basic client #14

Add basic client #14

Conversation

dostuffthatmatters commented Sep 11, 2023 • edited Loading

cloudflare-workers-and-pages bot commented Sep 11, 2023 • edited Loading

Deploying with Cloudflare Pages

empicano commented Sep 12, 2023

dostuffthatmatters commented Sep 13, 2023 • edited Loading

dostuffthatmatters commented Sep 14, 2023

dostuffthatmatters commented Sep 15, 2023 • edited Loading

dostuffthatmatters commented Sep 11, 2023 •

edited

Loading

cloudflare-workers-and-pages bot commented Sep 11, 2023 •

edited

Loading

dostuffthatmatters commented Sep 13, 2023 •

edited

Loading

dostuffthatmatters commented Sep 15, 2023 •

edited

Loading