Restructure code - phase 3

thevickypedia · Sep 30, 2024 · 9b4365b · 9b4365b
1 parent 9df88cf
commit 9b4365b
Show file tree

Hide file tree

Showing 12 changed files with 1,225 additions and 942 deletions.
diff --git a/doc_gen/index.rst b/doc_gen/index.rst
@@ -17,137 +17,135 @@ PyNinja - Main
 
 .. automodule:: pyninja.main
 
-Authenticator
-=============
-.. automodule:: pyninja.auth
+PyNinja - Executors
+===================
 
-Routes
-======
+API Authenticator
+-----------------
+.. automodule:: pyninja.executors.auth
 
-.. automodule:: pyninja.routes
+Database
+--------
+.. automodule:: pyninja.executors.database
 
-Monitors
-========
+API Routes
+----------
+.. automodule:: pyninja.executors.routes
 
-Docker
+Squire
 ------
+.. automodule:: pyninja.executors.squire
 
-.. automodule:: pyninja.dockerized
+PyNinja - Features
+==================
+
+CPU
+---
+.. automodule:: pyninja.features.cpu
+
+Disks
+-----
+.. automodule:: pyninja.features.disks
+
+Docker
+------
+.. automodule:: pyninja.features.dockerized
 
 GPU
 ---
+.. automodule:: pyninja.features.gpu
 
-.. automodule:: pyninja.gpu
+Operations
+----------
+.. automodule:: pyninja.features.operations
 
 Process
 -------
-
-.. automodule:: pyninja.process
+.. automodule:: pyninja.features.process
 
 Service
 -------
+.. automodule:: pyninja.features.service
 
-.. automodule:: pyninja.service
-
-Operations
-==========
-
-.. automodule:: pyninja.operations
-
-Database
-========
-
-.. automodule:: pyninja.database
-
-RateLimiter
-===========
-
-.. automodule:: pyninja.rate_limit
+PyNinja - Modules
+=================
 
 Exceptions
-==========
-
-.. automodule:: pyninja.exceptions
+----------
+.. automodule:: pyninja.modules.exceptions
 
 Models
-======
-
-.. autoclass:: pyninja.models.Payload(BaseModel)
+------
+.. autoclass:: pyninja.modules.models.Payload(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.ServiceStatus(BaseModel)
+.. autoclass:: pyninja.modules.models.ServiceStatus(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.DiskLib(BaseModel)
+.. autoclass:: pyninja.modules.models.DiskLib(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.ServiceLib(BaseModel)
+.. autoclass:: pyninja.modules.models.ServiceLib(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.ProcessorLib(BaseModel)
+.. autoclass:: pyninja.modules.models.ProcessorLib(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.Session(BaseModel)
+.. autoclass:: pyninja.modules.models.Session(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.RateLimit(BaseModel)
+.. autoclass:: pyninja.modules.models.RateLimit(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.EnvConfig(BaseModel)
+.. autoclass:: pyninja.modules.models.EnvConfig(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. automodule:: pyninja.models
+.. automodule:: pyninja.modules.models
    :exclude-members: Payload, ServiceStatus, DiskLib, ServiceLib, ProcessorLib, EnvConfig, Session, RateLimit, env, database
 
-Squire
-======
+RateLimit
+---------
+.. automodule:: pyninja.modules.rate_limit
 
-.. automodule:: pyninja.squire
+Secure
+---------
+.. automodule:: pyninja.modules.secure
 
 PyNinja - Monitor
 =================
 
 Authenticator
 -------------
-
 .. automodule:: pyninja.monitor.authenticator
 
 Configuration
 -------------
-
 .. automodule:: pyninja.monitor.config
 
 Resources
 ---------
-
 .. automodule:: pyninja.monitor.resources
 
 Routes
 ------
-
 .. automodule:: pyninja.monitor.routes
 
-Secure
-------
-
-.. automodule:: pyninja.monitor.secure
-
 Indices and tables
 ==================
 

diff --git a/docs/README.html b/docs/README.html
@@ -4,7 +4,7 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />
 
     <title>PyNinja &#8212; PyNinja  documentation</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css" />

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -17,137 +17,135 @@ PyNinja - Main
 
 .. automodule:: pyninja.main
 
-Authenticator
-=============
-.. automodule:: pyninja.auth
+PyNinja - Executors
+===================
 
-Routes
-======
+API Authenticator
+-----------------
+.. automodule:: pyninja.executors.auth
 
-.. automodule:: pyninja.routes
+Database
+--------
+.. automodule:: pyninja.executors.database
 
-Monitors
-========
+API Routes
+----------
+.. automodule:: pyninja.executors.routes
 
-Docker
+Squire
 ------
+.. automodule:: pyninja.executors.squire
 
-.. automodule:: pyninja.dockerized
+PyNinja - Features
+==================
+
+CPU
+---
+.. automodule:: pyninja.features.cpu
+
+Disks
+-----
+.. automodule:: pyninja.features.disks
+
+Docker
+------
+.. automodule:: pyninja.features.dockerized
 
 GPU
 ---
+.. automodule:: pyninja.features.gpu
 
-.. automodule:: pyninja.gpu
+Operations
+----------
+.. automodule:: pyninja.features.operations
 
 Process
 -------
-
-.. automodule:: pyninja.process
+.. automodule:: pyninja.features.process
 
 Service
 -------
+.. automodule:: pyninja.features.service
 
-.. automodule:: pyninja.service
-
-Operations
-==========
-
-.. automodule:: pyninja.operations
-
-Database
-========
-
-.. automodule:: pyninja.database
-
-RateLimiter
-===========
-
-.. automodule:: pyninja.rate_limit
+PyNinja - Modules
+=================
 
 Exceptions
-==========
-
-.. automodule:: pyninja.exceptions
+----------
+.. automodule:: pyninja.modules.exceptions
 
 Models
-======
-
-.. autoclass:: pyninja.models.Payload(BaseModel)
+------
+.. autoclass:: pyninja.modules.models.Payload(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.ServiceStatus(BaseModel)
+.. autoclass:: pyninja.modules.models.ServiceStatus(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.DiskLib(BaseModel)
+.. autoclass:: pyninja.modules.models.DiskLib(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.ServiceLib(BaseModel)
+.. autoclass:: pyninja.modules.models.ServiceLib(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.ProcessorLib(BaseModel)
+.. autoclass:: pyninja.modules.models.ProcessorLib(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.Session(BaseModel)
+.. autoclass:: pyninja.modules.models.Session(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.RateLimit(BaseModel)
+.. autoclass:: pyninja.modules.models.RateLimit(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.models.EnvConfig(BaseModel)
+.. autoclass:: pyninja.modules.models.EnvConfig(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. automodule:: pyninja.models
+.. automodule:: pyninja.modules.models
    :exclude-members: Payload, ServiceStatus, DiskLib, ServiceLib, ProcessorLib, EnvConfig, Session, RateLimit, env, database
 
-Squire
-======
+RateLimit
+---------
+.. automodule:: pyninja.modules.rate_limit
 
-.. automodule:: pyninja.squire
+Secure
+---------
+.. automodule:: pyninja.modules.secure
 
 PyNinja - Monitor
 =================
 
 Authenticator
 -------------
-
 .. automodule:: pyninja.monitor.authenticator
 
 Configuration
 -------------
-
 .. automodule:: pyninja.monitor.config
 
 Resources
 ---------
-
 .. automodule:: pyninja.monitor.resources
 
 Routes
 ------
-
 .. automodule:: pyninja.monitor.routes
 
-Secure
-------
-
-.. automodule:: pyninja.monitor.secure
-
 Indices and tables
 ==================