Andrew Mirsky
55bc7a6255
Yakifo/amqtt#174 : move current implementation to mqtt3 namespace and mark mqtt module as deprecated. allows for a namespace for mqtt 5 implementation
2025-08-12 10:16:21 -04:00
Andrew Mirsky
2fa0604547
Plugin: determine authentication based on X509 certificates ( #264 )
...
* plugin for authenticating clients based on certificates
* create ca, server and device keys and certificates. certificate auth plugin verification (non linted)
* adding documentation for the various cli scripts and the CertificateAuthPlugin
* post_init was not running on client config. cafile, keyfile, certfile are part of the connection section
* 'broker' section of client config can be empty, but connection will either be provided by the user or the default
2025-08-09 14:52:35 -04:00
Andrew Mirsky
66ac74f3d2
clarifying documentation for plugins and client/broker configuration
2025-08-05 11:56:05 -04:00
Andrew Mirsky
f6ccdbc51c
splitting out contrib plugin documentation into separate pages
2025-07-30 09:32:56 -04:00
Andrew Mirsky
9370ad7f9a
Structured broker and client configurations ( #269 )
...
* wip for structured configs
* updating docs to pull descriptions from structured configs
* display 'default_factory' in a field as the actual value
* finalizing the dataclass style, format and content of the documentation for the BrokerConfig.
* updated documentation for broker and client config including finalizing the griffe extension to get the output of the default_factory's of dataclasses
* all test cases working. most fixes were to make the dataclass config's backwards compatible with how the rest of the code was accessing config dictionaries
* type correction and linting fixes
* updates to support python 3.10
* fixes to handle wonky yaml files
* removing non-modified template files
* adding documentation on the custom griffe extension to render the 'default_factory' for dataclass's 'field'
* refining documentation
* removing duplicate logger
2025-07-26 12:37:25 -04:00
Andrew Mirsky
33ac8b8dd7
add additional documentation for custom plugins
2025-07-10 12:29:59 -04:00
Andrew Mirsky
d78c184f86
Merge remote-tracking branch 'source/0.11.2-rc' into issues/27
2025-07-03 11:36:44 -04:00
Andrew Mirsky
2ceb2ae43b
resolves Yakifo/amqtt#27 Yakifo/amqtt#246 Yakifo/amqtt#123 : only retain messages for clients which specify clean session = 1 and messages are QoS 1 & 2. Also, clients which are completely anonymous, specifying no username, have no expectation of message retention.
2025-07-01 22:00:18 -04:00
Andrew Mirsky
92141d9a54
updating broker and client config documentation. updating description on how to create a custom plugin.
2025-06-28 23:02:02 -04:00
Andrew Mirsky
82c59cff9a
Merge branch '0.11.1-rc' into refine_sample_tests
2025-06-26 13:19:37 -04:00
Andrew Mirsky
1608edff91
add setting for connection timeout
2025-06-26 13:00:40 -04:00
Andrew Mirsky
bb76dbeec9
fixing config parameters for MQTTClient and updating docs to match. refining sample scripts to rely less on accessing external broker for successful completion
2025-06-25 22:24:14 -04:00
Andrew Mirsky
66eafd1e5c
separating docker build into two phases to minimize image size. add documentation for docker launch / configure
2025-06-09 14:32:55 -04:00
Andrew Mirsky
eebec2e604
adding documentation for additional client configuration options
2025-06-03 11:11:07 -04:00
Andrew Mirsky
1752895a39
fixes Yakifo/amqtt#159 : tests/test_client.py::test_client_publish_will_with_retain
2025-06-03 10:58:56 -04:00
Andrew Mirsky
1e1e2026d3
cleaning up plugin interface and documentation
2025-05-30 18:50:31 -04:00
Andrew Mirsky
9059f69776
refining the doc pages for the included scripts, use the actual command line help messages to generate the pages. clean up the command line help messages for consistency and clarity
2025-05-29 14:59:39 -04:00
Andrew Mirsky
55033db996
updating title
2025-05-28 09:35:03 -04:00
Andrew Mirsky
a3de71930c
adding favicon, broker and client config documents.
2025-05-28 08:39:02 -04:00
Andrew Mirsky
bffee5916b
consolidating configuration documentation for both broker and client. including making sure there's consistency in default configuration
2025-05-28 07:45:12 -04:00
Andrew Mirsky
c6abe5adeb
fixing client docstrings. plugin documentation expanded.
2025-05-22 15:24:13 -04:00
Andrew Mirsky
120ba1d699
updating client documentation by converting rst format into google docstring params, including examples from reference file
2025-05-21 21:59:12 -04:00
Andrew Mirsky
0ad46ef783
update to amqtt logo. revisions to amqtt docs
2025-05-21 12:37:02 -04:00
Andrew Mirsky
9e13cb9da4
convert rst files to md
2025-05-21 09:53:46 -04:00
Andrew Mirsky
335e0e20d1
initial conversion from sphinx to mkdocs
2025-05-20 20:57:08 -04:00
Andrew Mirsky
47765b437b
updating documentation, cleanup broken links. overhaul of the quickstart guide.
2025-05-20 19:40:56 -04:00
MVladislav
7cc746e483
refactor: base cleanup and bring project to run with test cases
2024-12-19 20:34:09 +01:00
Joe Keenan
9e1056080b
Remove leading slashes from example topics
...
Use of a leading slash is not best practice and should not appear in examples.
2022-01-30 21:57:09 +01:00
Florian Ludwig
1cbad5bc3a
update docs to reflect new name
2021-08-17 17:01:58 +02:00
Florian Ludwig
b958b6b29c
change name in CLI docs
2021-08-17 17:01:58 +02:00
Florian Ludwig
1d100e5c45
rename entry_points
2021-03-27 17:49:55 +01:00
Marius Kriegerowski
e0fabc0bc3
Refactor to comply python3.8
2021-03-09 19:13:32 +01:00
Zdzislaw Krajewski
e9db78a3b0
Add option for infitie reconnecting.
...
It simplifies reconnection logic. In case of long running services which publish data to server,
there is need to reconnect anyway. When reconnect_retries elapses, then reconnection have to be
done manually. Carrying about it inside coroutine which publishing data introduces complexity.
2019-02-25 14:55:51 +01:00
mitchbte
0cef54c715
Update mqttclient.rst
...
Fix missing variables
2019-01-23 16:59:17 +11:00
Román Cárdenas
cece85a75e
documentation
2019-01-05 19:49:00 +01:00
Román Cárdenas
c9f47e3996
minor changes
2019-01-04 18:33:10 +01:00
Román Cárdenas
8a46ff8963
minor changes
2019-01-04 18:31:42 +01:00
Román Cárdenas
9d81b1f4a9
ACL plugin and documentation
2019-01-04 18:29:48 +01:00
Schneider
7cc5e17988
improved documentation and script integration of extra_headers
2018-12-05 15:39:31 +01:00
Nguyễn Hồng Quân
04098b7ba8
Fix the Client doc
2017-10-18 17:54:19 +07:00
jcea
877f2ed5c8
Typo
2017-01-09 22:26:36 +01:00
Nicolas
18267d148e
#50
...
Fix documentation and samples
2016-07-31 18:29:41 +02:00
Florian Ludwig
a1bd7231b8
cleanup broker reference
2016-07-30 21:21:34 +02:00
Nico
82985b6f1c
Improve documentation
2015-11-13 22:07:58 +01:00
Nico
06597542ba
fix typo
2015-11-13 21:27:40 +01:00
Nico
58666d6f8f
Complete MQTTClient documentation
2015-11-13 21:24:43 +01:00
Nico
35c48ff9a8
Improve documentation
2015-11-12 22:57:00 +01:00
Nico
6c0657b438
Documentation update
2015-11-11 22:40:38 +01:00
Nico
263d86f942
Docstring
2015-11-08 20:46:58 +01:00
Nico
d71b9c1483
Fix toc and add missing documents
2015-11-06 23:02:19 +01:00