diff options
author | CoprDistGit <infra@openeuler.org> | 2023-03-09 11:30:49 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-03-09 11:30:49 +0000 |
commit | 744c00f438bf722a514f2d40e2916b8bbfeb3d51 (patch) | |
tree | f085f094e374f01fb528054c54ff4f2232f20359 | |
parent | c7771226339f1abfa1337124a529a09a2f212a26 (diff) |
automatic import of python-gmqtt
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-gmqtt.spec | 603 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 605 insertions, 0 deletions
@@ -0,0 +1 @@ +/gmqtt-0.6.12.tar.gz diff --git a/python-gmqtt.spec b/python-gmqtt.spec new file mode 100644 index 0000000..0c3e824 --- /dev/null +++ b/python-gmqtt.spec @@ -0,0 +1,603 @@ +%global _empty_manifest_terminate_build 0 +Name: python-gmqtt +Version: 0.6.12 +Release: 1 +Summary: Client for MQTT protocol +License: MIT +URL: https://github.com/wialon/gmqtt +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/70/d5/2068751c6142d3b00d485f6a25f5b283fa285b88a2914118cacb9e367add/gmqtt-0.6.12.tar.gz +BuildArch: noarch + +Requires: python3-atomicwrites +Requires: python3-attrs +Requires: python3-codecov +Requires: python3-coverage +Requires: python3-more-itertools +Requires: python3-pluggy +Requires: python3-py +Requires: python3-pytest-asyncio +Requires: python3-pytest-cov +Requires: python3-pytest +Requires: python3-six +Requires: python3-uvloop + +%description +[](https://badge.fury.io/py/gmqtt) [](https://travis-ci.com/wialon/gmqtt) [](https://codecov.io/gh/wialon/gmqtt) + + +### gmqtt: Python async MQTT client implementation. + + + +### Installation + +The latest stable version is available in the Python Package Index (PyPi) and can be installed using +```bash +pip3 install gmqtt +``` + + +### Usage +#### Getting Started + +Here is a very simple example that subscribes to the broker TOPIC topic and prints out the resulting messages: + +```python +import asyncio +import os +import signal +import time + +from gmqtt import Client as MQTTClient + +# gmqtt also compatibility with uvloop +import uvloop +asyncio.set_event_loop_policy(uvloop.EventLoopPolicy()) + + +STOP = asyncio.Event() + + +def on_connect(client, flags, rc, properties): + print('Connected') + client.subscribe('TEST/#', qos=0) + + +def on_message(client, topic, payload, qos, properties): + print('RECV MSG:', payload) + + +def on_disconnect(client, packet, exc=None): + print('Disconnected') + +def on_subscribe(client, mid, qos, properties): + print('SUBSCRIBED') + +def ask_exit(*args): + STOP.set() + +async def main(broker_host, token): + client = MQTTClient("client-id") + + client.on_connect = on_connect + client.on_message = on_message + client.on_disconnect = on_disconnect + client.on_subscribe = on_subscribe + + client.set_auth_credentials(token, None) + await client.connect(broker_host) + + client.publish('TEST/TIME', str(time.time()), qos=1) + + await STOP.wait() + await client.disconnect() + + +if __name__ == '__main__': + loop = asyncio.get_event_loop() + + host = 'mqtt.flespi.io' + token = os.environ.get('FLESPI_TOKEN') + + loop.add_signal_handler(signal.SIGINT, ask_exit) + loop.add_signal_handler(signal.SIGTERM, ask_exit) + + loop.run_until_complete(main(host, token)) +``` + +### MQTT Version 5.0 +gmqtt supports MQTT version 5.0 protocol + +#### Version setup +Version 5.0 is used by default. If your broker does not support 5.0 protocol version and responds with proper CONNACK reason code, client will downgrade to 3.1 and reconnect automatically. Note, that some brokers just fail to parse the 5.0 format CONNECT packet, so first check manually if your broker handles this properly. +You can also force version in connect method: +```python +from gmqtt.mqtt.constants import MQTTv311 +client = MQTTClient('clientid') +client.set_auth_credentials(token, None) +await client.connect(broker_host, 1883, keepalive=60, version=MQTTv311) +``` + +#### Properties +MQTT 5.0 protocol allows to include custom properties into packages, here is example of passing response topic property in published message: +```python + +TOPIC = 'testtopic/TOPIC' + +def on_connect(client, flags, rc, properties): + client.subscribe(TOPIC, qos=1) + print('Connected') + +def on_message(client, topic, payload, qos, properties): + print('RECV MSG:', topic, payload.decode(), properties) + +async def main(broker_host, token): + client = MQTTClient('asdfghjk') + client.on_message = on_message + client.on_connect = on_connect + client.set_auth_credentials(token, None) + await client.connect(broker_host, 1883, keepalive=60) + client.publish(TOPIC, 'Message payload', response_topic='RESPONSE/TOPIC') + + await STOP.wait() + await client.disconnect() +``` +##### Connect properties +Connect properties are passed to `Client` object as kwargs (later they are stored together with properties received from broker in `client.properties` field). See example below. +* `session_expiry_interval` - `int` Session expiry interval in seconds. If the Session Expiry Interval is absent the value 0 is used. If it is set to 0, or is absent, the Session ends when the Network Connection is closed. If the Session Expiry Interval is 0xFFFFFFFF (max possible value), the Session does not expire. +* `receive_maximum` - `int` The Client uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently. +* `user_property` - `tuple(str, str)` This property may be used to provide additional diagnostic or other information (key-value pairs). +* `maximum_packet_size` - `int` The Client uses the Maximum Packet Size (in bytes) to inform the Server that it will not process packets exceeding this limit. + +Example: +```python +client = gmqtt.Client("lenkaklient", receive_maximum=24000, session_expiry_interval=60, user_property=('myid', '12345')) +``` + +##### Publish properties +This properties will be also sent in publish packet from broker, they will be passed to `on_message` callback. +* `message_expiry_interval` - `int` If present, the value is the lifetime of the Application Message in seconds. +* `content_type` - `unicode` UTF-8 Encoded String describing the content of the Application Message. The value of the Content Type is defined by the sending and receiving application. +* `user_property` - `tuple(str, str)` +* `subscription_identifier` - `int` (see subscribe properties) sent by broker +* `topic_alias` - `int` First client publishes messages with topic string and kwarg topic_alias. After this initial message client can publish message with empty string topic and same topic_alias kwarg. + +Example: +```python +def on_message(client, topic, payload, qos, properties): + # properties example here: {'content_type': ['json'], 'user_property': [('timestamp', '1524235334.881058')], 'message_expiry_interval': [60], 'subscription_identifier': [42, 64]} + print('RECV MSG:', topic, payload, properties) + +client.publish('TEST/TIME', str(time.time()), qos=1, retain=True, message_expiry_interval=60, content_type='json') +``` + +##### Subscribe properties +* `subscription_identifier` - `int` If the Client specified a Subscription Identifier for any of the overlapping subscriptions the Server MUST send those Subscription Identifiers in the message which is published as the result of the subscriptions. + +### Reconnects +By default, connected MQTT client will always try to reconnect in case of lost connections. Number of reconnect attempts is unlimited. +If you want to change this behaviour, do the following: +```python +client = MQTTClient("client-id") +client.set_config({'reconnect_retries': 10, 'reconnect_delay': 60}) +``` +Code above will set number of reconnect attempts to 10 and delay between reconnect attempts to 1min (60s). By default `reconnect_delay=6` and `reconnect_retries=-1` which stands for infinity. +Note that manually calling `await client.disconnect()` will set `reconnect_retries` for 0, which will stop auto reconnect. + +### Asynchronous on_message callback +You can define asynchronous on_message callback. +Note that it must return valid PUBACK code (`0` is success code, see full list in [constants](gmqtt/mqtt/constants.py#L69)) +```python +async def on_message(client, topic, payload, qos, properties): + pass + return 0 +``` + +### Other examples +Check [examples directory](examples) for more use cases. + + +%package -n python3-gmqtt +Summary: Client for MQTT protocol +Provides: python-gmqtt +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-gmqtt +[](https://badge.fury.io/py/gmqtt) [](https://travis-ci.com/wialon/gmqtt) [](https://codecov.io/gh/wialon/gmqtt) + + +### gmqtt: Python async MQTT client implementation. + + + +### Installation + +The latest stable version is available in the Python Package Index (PyPi) and can be installed using +```bash +pip3 install gmqtt +``` + + +### Usage +#### Getting Started + +Here is a very simple example that subscribes to the broker TOPIC topic and prints out the resulting messages: + +```python +import asyncio +import os +import signal +import time + +from gmqtt import Client as MQTTClient + +# gmqtt also compatibility with uvloop +import uvloop +asyncio.set_event_loop_policy(uvloop.EventLoopPolicy()) + + +STOP = asyncio.Event() + + +def on_connect(client, flags, rc, properties): + print('Connected') + client.subscribe('TEST/#', qos=0) + + +def on_message(client, topic, payload, qos, properties): + print('RECV MSG:', payload) + + +def on_disconnect(client, packet, exc=None): + print('Disconnected') + +def on_subscribe(client, mid, qos, properties): + print('SUBSCRIBED') + +def ask_exit(*args): + STOP.set() + +async def main(broker_host, token): + client = MQTTClient("client-id") + + client.on_connect = on_connect + client.on_message = on_message + client.on_disconnect = on_disconnect + client.on_subscribe = on_subscribe + + client.set_auth_credentials(token, None) + await client.connect(broker_host) + + client.publish('TEST/TIME', str(time.time()), qos=1) + + await STOP.wait() + await client.disconnect() + + +if __name__ == '__main__': + loop = asyncio.get_event_loop() + + host = 'mqtt.flespi.io' + token = os.environ.get('FLESPI_TOKEN') + + loop.add_signal_handler(signal.SIGINT, ask_exit) + loop.add_signal_handler(signal.SIGTERM, ask_exit) + + loop.run_until_complete(main(host, token)) +``` + +### MQTT Version 5.0 +gmqtt supports MQTT version 5.0 protocol + +#### Version setup +Version 5.0 is used by default. If your broker does not support 5.0 protocol version and responds with proper CONNACK reason code, client will downgrade to 3.1 and reconnect automatically. Note, that some brokers just fail to parse the 5.0 format CONNECT packet, so first check manually if your broker handles this properly. +You can also force version in connect method: +```python +from gmqtt.mqtt.constants import MQTTv311 +client = MQTTClient('clientid') +client.set_auth_credentials(token, None) +await client.connect(broker_host, 1883, keepalive=60, version=MQTTv311) +``` + +#### Properties +MQTT 5.0 protocol allows to include custom properties into packages, here is example of passing response topic property in published message: +```python + +TOPIC = 'testtopic/TOPIC' + +def on_connect(client, flags, rc, properties): + client.subscribe(TOPIC, qos=1) + print('Connected') + +def on_message(client, topic, payload, qos, properties): + print('RECV MSG:', topic, payload.decode(), properties) + +async def main(broker_host, token): + client = MQTTClient('asdfghjk') + client.on_message = on_message + client.on_connect = on_connect + client.set_auth_credentials(token, None) + await client.connect(broker_host, 1883, keepalive=60) + client.publish(TOPIC, 'Message payload', response_topic='RESPONSE/TOPIC') + + await STOP.wait() + await client.disconnect() +``` +##### Connect properties +Connect properties are passed to `Client` object as kwargs (later they are stored together with properties received from broker in `client.properties` field). See example below. +* `session_expiry_interval` - `int` Session expiry interval in seconds. If the Session Expiry Interval is absent the value 0 is used. If it is set to 0, or is absent, the Session ends when the Network Connection is closed. If the Session Expiry Interval is 0xFFFFFFFF (max possible value), the Session does not expire. +* `receive_maximum` - `int` The Client uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently. +* `user_property` - `tuple(str, str)` This property may be used to provide additional diagnostic or other information (key-value pairs). +* `maximum_packet_size` - `int` The Client uses the Maximum Packet Size (in bytes) to inform the Server that it will not process packets exceeding this limit. + +Example: +```python +client = gmqtt.Client("lenkaklient", receive_maximum=24000, session_expiry_interval=60, user_property=('myid', '12345')) +``` + +##### Publish properties +This properties will be also sent in publish packet from broker, they will be passed to `on_message` callback. +* `message_expiry_interval` - `int` If present, the value is the lifetime of the Application Message in seconds. +* `content_type` - `unicode` UTF-8 Encoded String describing the content of the Application Message. The value of the Content Type is defined by the sending and receiving application. +* `user_property` - `tuple(str, str)` +* `subscription_identifier` - `int` (see subscribe properties) sent by broker +* `topic_alias` - `int` First client publishes messages with topic string and kwarg topic_alias. After this initial message client can publish message with empty string topic and same topic_alias kwarg. + +Example: +```python +def on_message(client, topic, payload, qos, properties): + # properties example here: {'content_type': ['json'], 'user_property': [('timestamp', '1524235334.881058')], 'message_expiry_interval': [60], 'subscription_identifier': [42, 64]} + print('RECV MSG:', topic, payload, properties) + +client.publish('TEST/TIME', str(time.time()), qos=1, retain=True, message_expiry_interval=60, content_type='json') +``` + +##### Subscribe properties +* `subscription_identifier` - `int` If the Client specified a Subscription Identifier for any of the overlapping subscriptions the Server MUST send those Subscription Identifiers in the message which is published as the result of the subscriptions. + +### Reconnects +By default, connected MQTT client will always try to reconnect in case of lost connections. Number of reconnect attempts is unlimited. +If you want to change this behaviour, do the following: +```python +client = MQTTClient("client-id") +client.set_config({'reconnect_retries': 10, 'reconnect_delay': 60}) +``` +Code above will set number of reconnect attempts to 10 and delay between reconnect attempts to 1min (60s). By default `reconnect_delay=6` and `reconnect_retries=-1` which stands for infinity. +Note that manually calling `await client.disconnect()` will set `reconnect_retries` for 0, which will stop auto reconnect. + +### Asynchronous on_message callback +You can define asynchronous on_message callback. +Note that it must return valid PUBACK code (`0` is success code, see full list in [constants](gmqtt/mqtt/constants.py#L69)) +```python +async def on_message(client, topic, payload, qos, properties): + pass + return 0 +``` + +### Other examples +Check [examples directory](examples) for more use cases. + + +%package help +Summary: Development documents and examples for gmqtt +Provides: python3-gmqtt-doc +%description help +[](https://badge.fury.io/py/gmqtt) [](https://travis-ci.com/wialon/gmqtt) [](https://codecov.io/gh/wialon/gmqtt) + + +### gmqtt: Python async MQTT client implementation. + + + +### Installation + +The latest stable version is available in the Python Package Index (PyPi) and can be installed using +```bash +pip3 install gmqtt +``` + + +### Usage +#### Getting Started + +Here is a very simple example that subscribes to the broker TOPIC topic and prints out the resulting messages: + +```python +import asyncio +import os +import signal +import time + +from gmqtt import Client as MQTTClient + +# gmqtt also compatibility with uvloop +import uvloop +asyncio.set_event_loop_policy(uvloop.EventLoopPolicy()) + + +STOP = asyncio.Event() + + +def on_connect(client, flags, rc, properties): + print('Connected') + client.subscribe('TEST/#', qos=0) + + +def on_message(client, topic, payload, qos, properties): + print('RECV MSG:', payload) + + +def on_disconnect(client, packet, exc=None): + print('Disconnected') + +def on_subscribe(client, mid, qos, properties): + print('SUBSCRIBED') + +def ask_exit(*args): + STOP.set() + +async def main(broker_host, token): + client = MQTTClient("client-id") + + client.on_connect = on_connect + client.on_message = on_message + client.on_disconnect = on_disconnect + client.on_subscribe = on_subscribe + + client.set_auth_credentials(token, None) + await client.connect(broker_host) + + client.publish('TEST/TIME', str(time.time()), qos=1) + + await STOP.wait() + await client.disconnect() + + +if __name__ == '__main__': + loop = asyncio.get_event_loop() + + host = 'mqtt.flespi.io' + token = os.environ.get('FLESPI_TOKEN') + + loop.add_signal_handler(signal.SIGINT, ask_exit) + loop.add_signal_handler(signal.SIGTERM, ask_exit) + + loop.run_until_complete(main(host, token)) +``` + +### MQTT Version 5.0 +gmqtt supports MQTT version 5.0 protocol + +#### Version setup +Version 5.0 is used by default. If your broker does not support 5.0 protocol version and responds with proper CONNACK reason code, client will downgrade to 3.1 and reconnect automatically. Note, that some brokers just fail to parse the 5.0 format CONNECT packet, so first check manually if your broker handles this properly. +You can also force version in connect method: +```python +from gmqtt.mqtt.constants import MQTTv311 +client = MQTTClient('clientid') +client.set_auth_credentials(token, None) +await client.connect(broker_host, 1883, keepalive=60, version=MQTTv311) +``` + +#### Properties +MQTT 5.0 protocol allows to include custom properties into packages, here is example of passing response topic property in published message: +```python + +TOPIC = 'testtopic/TOPIC' + +def on_connect(client, flags, rc, properties): + client.subscribe(TOPIC, qos=1) + print('Connected') + +def on_message(client, topic, payload, qos, properties): + print('RECV MSG:', topic, payload.decode(), properties) + +async def main(broker_host, token): + client = MQTTClient('asdfghjk') + client.on_message = on_message + client.on_connect = on_connect + client.set_auth_credentials(token, None) + await client.connect(broker_host, 1883, keepalive=60) + client.publish(TOPIC, 'Message payload', response_topic='RESPONSE/TOPIC') + + await STOP.wait() + await client.disconnect() +``` +##### Connect properties +Connect properties are passed to `Client` object as kwargs (later they are stored together with properties received from broker in `client.properties` field). See example below. +* `session_expiry_interval` - `int` Session expiry interval in seconds. If the Session Expiry Interval is absent the value 0 is used. If it is set to 0, or is absent, the Session ends when the Network Connection is closed. If the Session Expiry Interval is 0xFFFFFFFF (max possible value), the Session does not expire. +* `receive_maximum` - `int` The Client uses this value to limit the number of QoS 1 and QoS 2 publications that it is willing to process concurrently. +* `user_property` - `tuple(str, str)` This property may be used to provide additional diagnostic or other information (key-value pairs). +* `maximum_packet_size` - `int` The Client uses the Maximum Packet Size (in bytes) to inform the Server that it will not process packets exceeding this limit. + +Example: +```python +client = gmqtt.Client("lenkaklient", receive_maximum=24000, session_expiry_interval=60, user_property=('myid', '12345')) +``` + +##### Publish properties +This properties will be also sent in publish packet from broker, they will be passed to `on_message` callback. +* `message_expiry_interval` - `int` If present, the value is the lifetime of the Application Message in seconds. +* `content_type` - `unicode` UTF-8 Encoded String describing the content of the Application Message. The value of the Content Type is defined by the sending and receiving application. +* `user_property` - `tuple(str, str)` +* `subscription_identifier` - `int` (see subscribe properties) sent by broker +* `topic_alias` - `int` First client publishes messages with topic string and kwarg topic_alias. After this initial message client can publish message with empty string topic and same topic_alias kwarg. + +Example: +```python +def on_message(client, topic, payload, qos, properties): + # properties example here: {'content_type': ['json'], 'user_property': [('timestamp', '1524235334.881058')], 'message_expiry_interval': [60], 'subscription_identifier': [42, 64]} + print('RECV MSG:', topic, payload, properties) + +client.publish('TEST/TIME', str(time.time()), qos=1, retain=True, message_expiry_interval=60, content_type='json') +``` + +##### Subscribe properties +* `subscription_identifier` - `int` If the Client specified a Subscription Identifier for any of the overlapping subscriptions the Server MUST send those Subscription Identifiers in the message which is published as the result of the subscriptions. + +### Reconnects +By default, connected MQTT client will always try to reconnect in case of lost connections. Number of reconnect attempts is unlimited. +If you want to change this behaviour, do the following: +```python +client = MQTTClient("client-id") +client.set_config({'reconnect_retries': 10, 'reconnect_delay': 60}) +``` +Code above will set number of reconnect attempts to 10 and delay between reconnect attempts to 1min (60s). By default `reconnect_delay=6` and `reconnect_retries=-1` which stands for infinity. +Note that manually calling `await client.disconnect()` will set `reconnect_retries` for 0, which will stop auto reconnect. + +### Asynchronous on_message callback +You can define asynchronous on_message callback. +Note that it must return valid PUBACK code (`0` is success code, see full list in [constants](gmqtt/mqtt/constants.py#L69)) +```python +async def on_message(client, topic, payload, qos, properties): + pass + return 0 +``` + +### Other examples +Check [examples directory](examples) for more use cases. + + +%prep +%autosetup -n gmqtt-0.6.12 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-gmqtt -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Thu Mar 09 2023 Python_Bot <Python_Bot@openeuler.org> - 0.6.12-1 +- Package Spec generated @@ -0,0 +1 @@ +a459f34203a8a8013c081503d5b1db98 gmqtt-0.6.12.tar.gz |