ironflock 1.0.1__tar.gz → 1.0.3__tar.gz

{ironflock-1.0.1/ironflock.egg-info → ironflock-1.0.3}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: ironflock
-Version: 1.0.1
-Summary: Publishing data to a IronFlock Fleet Storage
-Home-page: https://github.com/RecordEvolution/ironflock-python
+Version: 1.0.3
+Summary: SDK to integrate your IronFlock Industry 4 Apps with the IronFlock Data Infrastructure
+Home-page: https://github.com/RecordEvolution/ironflock-py
 Author: Record Evolution GmbH
 Author-email: marko.petzold@record-evolution.de
 License: MIT
-Requires-Python: >=3.6
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: autobahn[asyncio,serialization]==22.3.2
@@ -28,23 +28,21 @@ For more information on the IronFlock IoT Devops Platform for engineers and deve
 import asyncio
 from ironflock import IronFlock
 
-# create a ironflock instance, which auto connects to the IronFlock Platform
-# the ironflock instance handles authentication and reconnects when the connection is lost
-rw = IronFlock()
+# create an IronFlock instance to connect to the IronFlock platform data infrastructure.
+# The IronFlock instance handles authentication when run on a device registered in IronFlock.
+ironflock = IronFlock()
 
 async def main():
     while True:
         # publish an event (if connection is not established the publish is skipped)
-        publication = await rw.publish("test.publish.com", {"temperature": 20})
+        publication = await ironflock.publish("test.publish.com", {"temperature": 20})
         print(publication)
         await asyncio.sleep(3)
 
 
 if __name__ == "__main__":
-    # run the main coroutine
-    asyncio.get_event_loop().create_task(main())
-    # run the ironflock component
-    rw.run()
+    ironflock = IronFlock(mainFunc=main)
+    ironflock.run()
 ```
 
 ## Options
@@ -62,7 +60,7 @@ The `IronFlock` `__init__` function can be configured with the following options
 ## Advanced Usage
 
 If you need more control, e.g. acting on lifecycle events (`onJoin`, `onLeave`) take a look at
-the [examples](./examples/) folder.
+the [examples](https://github.com/RecordEvolution/ironflock-py/tree/main/examples) folder.
 
 
 ## Development

{ironflock-1.0.1 → ironflock-1.0.3}/README.md

@@ -15,23 +15,21 @@ For more information on the IronFlock IoT Devops Platform for engineers and deve
 import asyncio
 from ironflock import IronFlock
 
-# create a ironflock instance, which auto connects to the IronFlock Platform
-# the ironflock instance handles authentication and reconnects when the connection is lost
-rw = IronFlock()
+# create an IronFlock instance to connect to the IronFlock platform data infrastructure.
+# The IronFlock instance handles authentication when run on a device registered in IronFlock.
+ironflock = IronFlock()
 
 async def main():
     while True:
         # publish an event (if connection is not established the publish is skipped)
-        publication = await rw.publish("test.publish.com", {"temperature": 20})
+        publication = await ironflock.publish("test.publish.com", {"temperature": 20})
         print(publication)
         await asyncio.sleep(3)
 
 
 if __name__ == "__main__":
-    # run the main coroutine
-    asyncio.get_event_loop().create_task(main())
-    # run the ironflock component
-    rw.run()
+    ironflock = IronFlock(mainFunc=main)
+    ironflock.run()
 ```
 
 ## Options
@@ -49,7 +47,7 @@ The `IronFlock` `__init__` function can be configured with the following options
 ## Advanced Usage
 
 If you need more control, e.g. acting on lifecycle events (`onJoin`, `onLeave`) take a look at
-the [examples](./examples/) folder.
+the [examples](https://github.com/RecordEvolution/ironflock-py/tree/main/examples) folder.
 
 
 ## Development

{ironflock-1.0.1 → ironflock-1.0.3/ironflock.egg-info}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: ironflock
-Version: 1.0.1
-Summary: Publishing data to a IronFlock Fleet Storage
-Home-page: https://github.com/RecordEvolution/ironflock-python
+Version: 1.0.3
+Summary: SDK to integrate your IronFlock Industry 4 Apps with the IronFlock Data Infrastructure
+Home-page: https://github.com/RecordEvolution/ironflock-py
 Author: Record Evolution GmbH
 Author-email: marko.petzold@record-evolution.de
 License: MIT
-Requires-Python: >=3.6
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: autobahn[asyncio,serialization]==22.3.2
@@ -28,23 +28,21 @@ For more information on the IronFlock IoT Devops Platform for engineers and deve
 import asyncio
 from ironflock import IronFlock
 
-# create a ironflock instance, which auto connects to the IronFlock Platform
-# the ironflock instance handles authentication and reconnects when the connection is lost
-rw = IronFlock()
+# create an IronFlock instance to connect to the IronFlock platform data infrastructure.
+# The IronFlock instance handles authentication when run on a device registered in IronFlock.
+ironflock = IronFlock()
 
 async def main():
     while True:
         # publish an event (if connection is not established the publish is skipped)
-        publication = await rw.publish("test.publish.com", {"temperature": 20})
+        publication = await ironflock.publish("test.publish.com", {"temperature": 20})
         print(publication)
         await asyncio.sleep(3)
 
 
 if __name__ == "__main__":
-    # run the main coroutine
-    asyncio.get_event_loop().create_task(main())
-    # run the ironflock component
-    rw.run()
+    ironflock = IronFlock(mainFunc=main)
+    ironflock.run()
 ```
 
 ## Options
@@ -62,7 +60,7 @@ The `IronFlock` `__init__` function can be configured with the following options
 ## Advanced Usage
 
 If you need more control, e.g. acting on lifecycle events (`onJoin`, `onLeave`) take a look at
-the [examples](./examples/) folder.
+the [examples](https://github.com/RecordEvolution/ironflock-py/tree/main/examples) folder.
 
 
 ## Development

{ironflock-1.0.1 → ironflock-1.0.3}/setup.py

@@ -10,16 +10,16 @@ with open("README.md", "r", encoding="utf-8") as fh:
 
 setup(
     name="ironflock",
-    version="1.0.1",
-    description="Publishing data to a IronFlock Fleet Storage",
+    version="1.0.3",
+    description="SDK to integrate your IronFlock Industry 4 Apps with the IronFlock Data Infrastructure",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    url="https://github.com/RecordEvolution/ironflock-python",
+    url="https://github.com/RecordEvolution/ironflock-py",
     author="Record Evolution GmbH",
     author_email="marko.petzold@record-evolution.de",
     packages=find_packages(),
     license="MIT",
-    python_requires=">=3.6",
+    python_requires=">=3.8",
     install_requires=requirements,
     classifiers=[],
 )