Add rate limit and brute force protection

Restructure code
thevickypedia · Aug 11, 2024 · 4d8612c · 4d8612c
1 parent 77284df
commit 4d8612c
Show file tree

Hide file tree

Showing 22 changed files with 957 additions and 302 deletions.
diff --git a/.gitignore b/.gitignore
@@ -14,5 +14,6 @@ temp.py
 
 logging.ini
 *.log
+*.db
 
 !samples/*
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 # PyNinja
-Light weight OS agnostic service monitoring API
+Lightweight OS-agnostic service monitoring API
 
 ![Python][label-pyversion]
 

diff --git a/doc_gen/index.rst b/doc_gen/index.rst
@@ -21,11 +21,6 @@ Authenticator
 =============
 .. automodule:: pyninja.auth
 
-Exceptions
-==========
-
-.. automodule:: pyninja.exceptions
-
 Routers
 =======
 
@@ -44,26 +39,56 @@ Service
 
 .. automodule:: pyninja.service
 
-Squire
+Database
+========
+
+.. automodule:: pyninja.database
+
+RateLimiter
+===========
+
+.. automodule:: pyninja.rate_limit
+
+Exceptions
+==========
+
+.. automodule:: pyninja.exceptions
+
+Models
 ======
 
-.. autoclass:: pyninja.squire.Payload(BaseModel)
+.. autoclass:: pyninja.models.Payload(BaseModel)
+   :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
+
+====
+
+.. autoclass:: pyninja.models.ServiceStatus(BaseModel)
+   :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
+
+====
+
+.. autoclass:: pyninja.models.Session(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.squire.ServiceStatus(BaseModel)
+.. autoclass:: pyninja.models.RateLimit(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.squire.EnvConfig(BaseModel)
+.. autoclass:: pyninja.models.EnvConfig(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
+.. automodule:: pyninja.models
+   :exclude-members: Payload, ServiceStatus, EnvConfig, Session, RateLimit, env, database
+
+Squire
+======
+
 .. automodule:: pyninja.squire
-   :exclude-members: Payload, ServiceStatus, EnvConfig
 
 Indices and tables
 ==================

diff --git a/docs/README.html b/docs/README.html
@@ -45,7 +45,7 @@ <h3>Navigation</h3>
 
   <section id="pyninja">
 <h1>PyNinja<a class="headerlink" href="#pyninja" title="Permalink to this heading">¶</a></h1>
-<p>Light weight OS agnostic service monitoring API</p>
+<p>Lightweight OS-agnostic service monitoring API</p>
 <p><img alt="Python" src="https://img.shields.io/badge/python-3.10%20%7C%203.11-blue" /></p>
 <p><strong>Platform Supported</strong></p>
 <p><img alt="Platform" src="https://img.shields.io/badge/Platform-Linux%7CmacOS%7CWindows-1f425f.svg" /></p>

diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,5 @@
 # PyNinja
-Light weight OS agnostic service monitoring API
+Lightweight OS-agnostic service monitoring API
 
 ![Python][label-pyversion]
 

diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
@@ -1,5 +1,5 @@
 # PyNinja
-Light weight OS agnostic service monitoring API
+Lightweight OS-agnostic service monitoring API
 
 ![Python][label-pyversion]
 

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -21,11 +21,6 @@ Authenticator
 =============
 .. automodule:: pyninja.auth
 
-Exceptions
-==========
-
-.. automodule:: pyninja.exceptions
-
 Routers
 =======
 
@@ -44,26 +39,56 @@ Service
 
 .. automodule:: pyninja.service
 
-Squire
+Database
+========
+
+.. automodule:: pyninja.database
+
+RateLimiter
+===========
+
+.. automodule:: pyninja.rate_limit
+
+Exceptions
+==========
+
+.. automodule:: pyninja.exceptions
+
+Models
 ======
 
-.. autoclass:: pyninja.squire.Payload(BaseModel)
+.. autoclass:: pyninja.models.Payload(BaseModel)
+   :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
+
+====
+
+.. autoclass:: pyninja.models.ServiceStatus(BaseModel)
+   :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
+
+====
+
+.. autoclass:: pyninja.models.Session(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.squire.ServiceStatus(BaseModel)
+.. autoclass:: pyninja.models.RateLimit(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
-.. autoclass:: pyninja.squire.EnvConfig(BaseModel)
+.. autoclass:: pyninja.models.EnvConfig(BaseModel)
    :exclude-members: _abc_impl, model_config, model_fields, model_computed_fields
 
 ====
 
+.. automodule:: pyninja.models
+   :exclude-members: Payload, ServiceStatus, EnvConfig, Session, RateLimit, env, database
+
+Squire
+======
+
 .. automodule:: pyninja.squire
-   :exclude-members: Payload, ServiceStatus, EnvConfig
 
 Indices and tables
 ==================
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,5 +14,6 @@ temp.py @@
     logging.ini
     *.log
+    *.db
     !samples/*