Merge pull request #30 from tomvictor/feature/fastapi

add Fastapi support

Author: tomvictor

README.md

@@ -1,16 +1,15 @@
-# iotcore - MQTT and IoT capabilities to Django Rest Framework and FastAPI.
+# Iotcore - MQTT and IoT capabilities to Django Rest Framework and FastAPI.
 
-
-Project under development. Apis can change often until stable.
+The project aims to give full support for mqtt based server and related apis. The internals of the mqtt server is
+written in golang. The python will not directly interact with the golang instead communicate using grpc(planned). The 
+motive is to avoid the GIL limitation of python and bring all the  fun features offered by golang.
 
 ## Planned Features
 
-* MQTT based IoT protocol 
-* MQTT broker with websocket and tcp support (Written in golang) 
-* Easy sensor data storage 
-* APIs for IoT Device management and storage 
-* Most of the IoT logics will be handled by inbuilt golang application. It will then communicate with the django using channels
-* and more coming soon 
+* Full fledged MQTT server
+* with websocket and tcp support (Written in golang)
+* MQTT v5 support
+* and more coming soon
 
 ## Installation
 
@@ -19,6 +18,52 @@ PyPI
 pip install iotcore
 ```
 
+# FastAPI setup
+
+```python
+from fastapi import FastAPI
+from contextlib import asynccontextmanager
+from iotcore import IotCore
+
+iot_core = IotCore()
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    iot_core.run()
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
+
+
+@app.get("/")
+def read_root():
+    return {"Hello": "World"}
+
+```
+
+Output
+
+```shell
+❯ cd examples/fastapi
+❯ uvicorn main:app
+INFO:     Started server process [62593]
+INFO:     Waiting for application startup.
+Starting Go process...
+INFO:     Application startup complete.
+INFO:     Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
+11:21PM INF added hook hook=allow-all-auth
+11:21PM INF attached listener address=:1883 id=t1 protocol=tcp
+11:21PM INF attached listener address=:1882 id=ws1 protocol=ws
+11:21PM INF attached listener address=:8080 id=stats protocol=http
+11:21PM INF mochi mqtt starting version=2.3.0
+11:21PM INF mochi mqtt server started
+
+```
+
+# Django Setup
+
 Then add iotcore to the django apps as below in the settings.py file of your project
 ```python
 INSTALLED_APPS = [
@@ -27,17 +72,16 @@ INSTALLED_APPS = [
 ]
 ```
 
-Now Connect to mqtt broker on localhost
-MQTT Port : 1883 
-Websocket Port : 1882 
-Stat Port: 8080 
+Now Connect to mqtt broker on localhost  
+MQTT Port : 1883  
+Websocket Port : 1882  
+Stat Port: 8080  
 
 # Run Example project
 
 ```shell
-cd example
 pip install -r requirements.txt
-python manage.py runserver
+python examples/manage.py runserver
 ```
 Output
 
@@ -58,6 +102,8 @@ Starting golang
 
 ```
 
+For more details check the example folder
+
 ## Development
 
 Use mage for development

config.json

@@ -1,5 +1,5 @@
 {
     "pypackage": "iotcore",
-    "version": "0.0.10",
+    "version": "0.0.11",
     "gobinary": "goiotbackend"
 }

iotcore/requirements.txt renamed to examples/django/requirements.txt

@@ -1,3 +1,3 @@
 django
-djangoiot
+iotcore
 psutil

examples/fastapi/main.py

@@ -0,0 +1,19 @@
+from fastapi import FastAPI
+from contextlib import asynccontextmanager
+from iotcore import IotCore
+
+iot_core = IotCore()
+
+
+@asynccontextmanager
+async def lifespan(app: FastAPI):
+    iot_core.run()
+    yield
+
+
+app = FastAPI(lifespan=lifespan)
+
+
+@app.get("/")
+def read_root():
+    return {"Hello": "World"}

examples/fastapi/requirements.txt

@@ -0,0 +1,3 @@
+psutil
+iotcore
+fastapi

iotcore/__init__.py

@@ -1 +1 @@
-from .core import IotCore
+from .core import IotCore

iotcore/__version__.py

@@ -1 +1 @@
-__version__ = '0.0.10'
+version = '0.0.11'

iotcore/core.py

@@ -4,7 +4,7 @@
 
 import psutil
 
-from djangoiot import __version__
+from .__version__ import version
 
 
 class IotCore(object):
@@ -28,14 +28,21 @@ def run(self):
             print("Starting Go process...")
             subprocess.Popen([self.executable_path()])
 
+    def clean(self):
+        # TODO: Clean the proces
+        raise NotImplementedError("clean function is not implemented")
+
+
+
+
     def executable_path(self):
         current_file_path = os.path.abspath(__file__)
         return os.path.join(os.path.dirname(current_file_path), self.executable)
 
     def get_executable_name(self):
         binary_map = {
-            "Darwin": f"{self.binary_prefix}-mac-{__version__}",
-            "Windows": f"{self.binary_prefix}-win-{__version__}.exe",
-            "Linux": f"{self.binary_prefix}-linux-{__version__}",
+            "Darwin": f"{self.binary_prefix}-mac-{version}",
+            "Windows": f"{self.binary_prefix}-win-{version}.exe",
+            "Linux": f"{self.binary_prefix}-linux-{version}",
         }
         return binary_map[platform.system()]

iotcore/djangoiot/apps.py

@@ -1,12 +1,12 @@
 from django.apps import AppConfig
-from djangoiot.core import IotCore
+from iotcore.core import IotCore
 
 iot_core = IotCore()
 
 
 class IotConfig(AppConfig):
     default_auto_field = "django.db.models.BigAutoField"
-    name = "djangoiot"
+    name = "iotcore.djangoiot"
 
     def ready(self):
         iot_core.run()

magefile.go

@@ -117,7 +117,7 @@ func Build() error {
 
 	BuildGo()
 
-	versionFileContent := fmt.Sprintf("__version__ = '%s'\n", Config().Version)
+	versionFileContent := fmt.Sprintf("version = '%s'\n", Config().Version)
 
 	file, err := os.OpenFile("iotcore/__version__.py", os.O_WRONLY|os.O_TRUNC, 0644)
 	if err != nil {