dev: Fixed class structure and unit tests

Taskfile.yaml

@@ -1,6 +1,6 @@
 version: '3'
 vars:
-    BUILD_DIR: config_gen
+    BUILD_DIR: fedi_gatus
 tasks:
     default:
         - task: test

docs/classes.dot

@@ -0,0 +1,4 @@
+digraph "classes" {
+rankdir=BT
+charset="utf-8"
+}

docs/fedi_gatus/api_server/api.md

@@ -0,0 +1,24 @@
+Module fedi_gatus.api_server.api
+================================
+
+Classes
+-------
+
+`Server()`
+:   
+
+    ### Class variables
+
+    `port`
+    :
+
+    ### Static methods
+
+    `local_nic()`
+    :
+
+    `start_server()`
+    :
+
+`web_app()`
+:

docs/fedi_gatus/api_server/index.md

@@ -0,0 +1,6 @@
+Namespace fedi_gatus.api_server
+===============================
+
+Sub-modules
+-----------
+* fedi_gatus.api_server.api

docs/fedi_gatus/data.md → docs/fedi_gatus/config_gen/data.md

@@ -1,5 +1,5 @@
-Module fedi_gatus.data
-======================
+Module fedi_gatus.config_gen.data
+=================================
 
 Functions
 ---------

docs/fedi_gatus/config_gen.md → docs/fedi_gatus/config_gen/generator.md

@@ -1,11 +1,11 @@
-Module fedi_gatus.config_gen
-============================
+Module fedi_gatus.config_gen.generator
+======================================
 
 Functions
 ---------
 
 
-`generate_endpoints(endpoint_list: [<class 'dict'>])`
+`Generate_endpoints(endpoint_list: [<class 'dict'>])`
 :   
 
 

docs/fedi_gatus/config_gen/index.md

@@ -0,0 +1,7 @@
+Namespace fedi_gatus.config_gen
+===============================
+
+Sub-modules
+-----------
+* fedi_gatus.config_gen.data
+* fedi_gatus.config_gen.generator

docs/fedi_gatus/index.md

@@ -3,6 +3,6 @@ Module fedi_gatus
 
 Sub-modules
 -----------
+* fedi_gatus.api_server
 * fedi_gatus.config_gen
-* fedi_gatus.data
-* fedi_gatus.db
+* fedi_gatus.shared

docs/fedi_gatus/db.md → docs/fedi_gatus/shared/db.md

@@ -1,5 +1,5 @@
-Module fedi_gatus.db
-====================
+Module fedi_gatus.shared.db
+===========================
 
 Functions
 ---------
@@ -11,13 +11,13 @@ Functions
 Classes
 -------
 
-`Data(*args, **kwargs)`
+`DataAccess(*args, **kwargs)`
 :   
 
     ### Ancestors (in MRO)
 
-    * fedi_gatus.db.DataModel
-    * fedi_gatus.db.ModelBase
+    * fedi_gatus.shared.db.DataModel
+    * fedi_gatus.shared.db.ModelBase
     * peewee.Model
     * peewee._metaclass_helper_
     * peewee.Node
@@ -27,36 +27,42 @@ Classes
     `id`
     :
 
+    `some_data`
+    :
+
     `timestamp`
     :
 
     ### Methods
 
-    `get(self, num_minutes_to_get: int) ‑> list`
-    :   Takes time range of past mins, and returns list of db rows w/ temp data
+    `get_single_record(self) ‑> dict`
+    :
 
-    `insert(self) ‑> None`
+    `insert(self, some_data: str) ‑> None`
     :
 
 `DataModel(*args, **kwargs)`
 :   
 
     ### Ancestors (in MRO)
 
-    * fedi_gatus.db.ModelBase
+    * fedi_gatus.shared.db.ModelBase
     * peewee.Model
     * peewee._metaclass_helper_
     * peewee.Node
 
     ### Descendants
 
-    * fedi_gatus.db.Data
+    * fedi_gatus.shared.db.DataAccess
 
     ### Class variables
 
     `id`
     :
 
+    `some_data`
+    :
+
     `timestamp`
     :
 
@@ -71,7 +77,7 @@ Classes
 
     ### Descendants
 
-    * fedi_gatus.db.DataModel
+    * fedi_gatus.shared.db.DataModel
 
     ### Class variables
 

docs/fedi_gatus/shared/index.md

@@ -0,0 +1,6 @@
+Namespace fedi_gatus.shared
+===========================
+
+Sub-modules
+-----------
+* fedi_gatus.shared.db

fedi_gatus/config_gen/generator.py

@@ -1,6 +1,6 @@
 import yaml
 
-import data
+from fedi_gatus.config_gen import data
 
 # example template
 x = """

tests/test_fedi_gatus.py → tests/test_main.py

@@ -1,35 +1,33 @@
+import logging
 
 import dotenv
 
-import config_gen.generator
+from fedi_gatus.config_gen import generator
 
 dotenv.load_dotenv()
 
-from fedi_gatus.config_gen import *
-from fedi_gatus.
-class TestConfig:
 
+class TestConfig:
     @classmethod
     def test_config_gen(cls):
         d = [{"name": "Lemmy World", "url": "https://lemmy.world"}, {"name": "Lemmy ML", "url": "https://lemmy.ml"}]
-        out = config_gen.generator.Generate_endpoints(d)
+        out = generator.Generate_endpoints(d)
         assert out is not None
         return out
 
     @classmethod
     def test_ui_gen(cls):
-        result = config_gen.generator.generate_ui()
+        result = generator.generate_ui()
         logging.info(result)
         assert result is not None
         return result
 
     def test_generate_full_config(cls):
-        x = config_gen.generator.generate_full_config()
+        x = generator.generate_full_config()
         logging.debug(x)
         assert x is not None
 
     # @pytest.mark.skip(reason="This takes a long time to run right now")
-    def test_get_data(self):
-
-        # TODO Fix Unit test
-        fedi_gatus.data.generate_top_instances()  # skip
+    # def test_get_data(self):
+    #     # TODO Fix Unit test
+    #     config_gen.generator.generate_full_config()