ironflock 1.0.1__py3-none-any.whl → 1.0.2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,106 @@
1
+ Metadata-Version: 2.1
2
+ Name: ironflock
3
+ Version: 1.0.2
4
+ Summary: SDK to integrate your IronFlock Industry 4 Apps with the IronFlock Data Infrastructure
5
+ Home-page: https://github.com/RecordEvolution/ironflock-python
6
+ Author: Record Evolution GmbH
7
+ Author-email: Marko Petzold <marko.petzold@record-evolution.de>
8
+ License: MIT License
9
+
10
+ Copyright (c) 2021 Record Evolution
11
+
12
+ Permission is hereby granted, free of charge, to any person obtaining a copy
13
+ of this software and associated documentation files (the "Software"), to deal
14
+ in the Software without restriction, including without limitation the rights
15
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
16
+ copies of the Software, and to permit persons to whom the Software is
17
+ furnished to do so, subject to the following conditions:
18
+
19
+ The above copyright notice and this permission notice shall be included in all
20
+ copies or substantial portions of the Software.
21
+
22
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
23
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
25
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
27
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
28
+ SOFTWARE.
29
+
30
+ Project-URL: Homepage, https://github.com/RecordEvolution/ironflock-py
31
+ Project-URL: Issues, https://github.com/RecordEvolution/ironflock-py/issues
32
+ Classifier: Programming Language :: Python :: 3
33
+ Classifier: License :: OSI Approved :: MIT License
34
+ Classifier: Operating System :: OS Independent
35
+ Requires-Python: >=3.6
36
+ Description-Content-Type: text/markdown
37
+ License-File: LICENSE
38
+ Requires-Dist: autobahn[asyncio,serialization]==22.3.2
39
+
40
+ # ironflock
41
+
42
+ ## About
43
+
44
+ With this library you can publish data from your apps on your IoT edge hardware to the fleet data storage of the [IronFlock](https://studio.ironflock.com) devops platform.
45
+ When this library is used on a certain device the library automatically uses the private messaging realm (Unified Name Space)
46
+ of the device's fleet and the data is collected in the respective fleet database.
47
+
48
+ So if you use the library in your app, the data collection will always be private to the app user's fleet.
49
+
50
+ For more information on the IronFlock IoT Devops Platform for engineers and developers visit our [IronFlock](https://www.ironflock.com) home page.
51
+ ## Usage
52
+
53
+ ```python
54
+ import asyncio
55
+ from ironflock import IronFlock
56
+
57
+ # create an IronFlock instance to connect to the IronFlock platform data infrastructure.
58
+ # The IronFlock instance handles authentication when run on a device registered in IronFlock.
59
+ ironflock = IronFlock()
60
+
61
+ async def main():
62
+ while True:
63
+ # publish an event (if connection is not established the publish is skipped)
64
+ publication = await ironflock.publish("test.publish.com", {"temperature": 20})
65
+ print(publication)
66
+ await asyncio.sleep(3)
67
+
68
+
69
+ if __name__ == "__main__":
70
+ ironflock = IronFlock(mainFunc=main)
71
+ ironflock.run()
72
+ ```
73
+
74
+ ## Options
75
+
76
+ The `IronFlock` `__init__` function can be configured with the following options:
77
+
78
+ ```ts
79
+ {
80
+ serial_number: string;
81
+ }
82
+ ```
83
+
84
+ **serial_number**: Used to set the serial_number of the device if the `DEVICE_SERIAL_NUMBER` environment variable does not exist. It can also be used if the user wishes to authenticate as another device.
85
+
86
+ ## Advanced Usage
87
+
88
+ If you need more control, e.g. acting on lifecycle events (`onJoin`, `onLeave`) take a look at
89
+ the [examples](./examples/) folder.
90
+
91
+
92
+ ## Development
93
+
94
+ Install the necessary components if you don't have them already:
95
+
96
+ ```shell
97
+ pip install --upgrade setuptools wheel twine
98
+ ```
99
+
100
+ Build and publish a new pypi package:
101
+
102
+ ```shell
103
+ make publish
104
+ ```
105
+
106
+ Check the package at https://pypi.org/project/ironflock/.
@@ -0,0 +1,8 @@
1
+ ironflock/AutobahnConnection.py,sha256=clwEsptqQFjDFn4dUGN4bQyb1cOnPmmNjetfTrRqckY,3687
2
+ ironflock/__init__.py,sha256=LsyyAenv7GrvQSmPc3QJDu7_VsK7BDIvbwGC8ebEI9A,265
3
+ ironflock/ironflock.py,sha256=ZVshk0ky9rOPbNlLHUW-LgjuFl_YJbm3zqLvKSLjRs8,5892
4
+ ironflock-1.0.2.dist-info/LICENSE,sha256=GpUKjPB381nmkbBIdX74vxXhsNZaNpngTOciss39Pjk,1073
5
+ ironflock-1.0.2.dist-info/METADATA,sha256=KcF1BA68yQcWRgHbi9O4xSuN7K6XHUV8-Bs3hiCnwBo,4044
6
+ ironflock-1.0.2.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
7
+ ironflock-1.0.2.dist-info/top_level.txt,sha256=hmMdMPJuvnOTlFKYl1XQOn81vg1DE2LT7xrEXgyxcRA,10
8
+ ironflock-1.0.2.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (72.1.0)
2
+ Generator: setuptools (75.1.0)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5
 
@@ -1,82 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: ironflock
3
- Version: 1.0.1
4
- Summary: Publishing data to a IronFlock Fleet Storage
5
- Home-page: https://github.com/RecordEvolution/ironflock-python
6
- Author: Record Evolution GmbH
7
- Author-email: marko.petzold@record-evolution.de
8
- License: MIT
9
- Requires-Python: >=3.6
10
- Description-Content-Type: text/markdown
11
- License-File: LICENSE
12
- Requires-Dist: autobahn[asyncio,serialization] ==22.3.2
13
-
14
- # ironflock
15
-
16
- ## About
17
-
18
- With this library you can publish data from your apps on your IoT edge hardware to the fleet data storage of the [IronFlock](https://studio.ironflock.com) devops platform.
19
- When this library is used on a certain device the library automatically uses the private messaging realm (Unified Name Space)
20
- of the device's fleet and the data is collected in the respective fleet database.
21
-
22
- So if you use the library in your app, the data collection will always be private to the app user's fleet.
23
-
24
- For more information on the IronFlock IoT Devops Platform for engineers and developers visit our [IronFlock](https://www.ironflock.com) home page.
25
- ## Usage
26
-
27
- ```python
28
- import asyncio
29
- from ironflock import IronFlock
30
-
31
- # create a ironflock instance, which auto connects to the IronFlock Platform
32
- # the ironflock instance handles authentication and reconnects when the connection is lost
33
- rw = IronFlock()
34
-
35
- async def main():
36
- while True:
37
- # publish an event (if connection is not established the publish is skipped)
38
- publication = await rw.publish("test.publish.com", {"temperature": 20})
39
- print(publication)
40
- await asyncio.sleep(3)
41
-
42
-
43
- if __name__ == "__main__":
44
- # run the main coroutine
45
- asyncio.get_event_loop().create_task(main())
46
- # run the ironflock component
47
- rw.run()
48
- ```
49
-
50
- ## Options
51
-
52
- The `IronFlock` `__init__` function can be configured with the following options:
53
-
54
- ```ts
55
- {
56
- serial_number: string;
57
- }
58
- ```
59
-
60
- **serial_number**: Used to set the serial_number of the device if the `DEVICE_SERIAL_NUMBER` environment variable does not exist. It can also be used if the user wishes to authenticate as another device.
61
-
62
- ## Advanced Usage
63
-
64
- If you need more control, e.g. acting on lifecycle events (`onJoin`, `onLeave`) take a look at
65
- the [examples](./examples/) folder.
66
-
67
-
68
- ## Development
69
-
70
- Install the necessary components if you don't have them already:
71
-
72
- ```shell
73
- pip install --upgrade setuptools wheel twine
74
- ```
75
-
76
- Build and publish a new pypi package:
77
-
78
- ```shell
79
- make publish
80
- ```
81
-
82
- Check the package at https://pypi.org/project/ironflock/.
@@ -1,8 +0,0 @@
1
- ironflock/AutobahnConnection.py,sha256=clwEsptqQFjDFn4dUGN4bQyb1cOnPmmNjetfTrRqckY,3687
2
- ironflock/__init__.py,sha256=LsyyAenv7GrvQSmPc3QJDu7_VsK7BDIvbwGC8ebEI9A,265
3
- ironflock/ironflock.py,sha256=ZVshk0ky9rOPbNlLHUW-LgjuFl_YJbm3zqLvKSLjRs8,5892
4
- ironflock-1.0.1.dist-info/LICENSE,sha256=GpUKjPB381nmkbBIdX74vxXhsNZaNpngTOciss39Pjk,1073
5
- ironflock-1.0.1.dist-info/METADATA,sha256=ONGtcs6swb7JV50gQZIIUYQSEOcVBsp3rXQ-2NJ_rV8,2491
6
- ironflock-1.0.1.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
7
- ironflock-1.0.1.dist-info/top_level.txt,sha256=hmMdMPJuvnOTlFKYl1XQOn81vg1DE2LT7xrEXgyxcRA,10
8
- ironflock-1.0.1.dist-info/RECORD,,