Restructure enums and runbook

thevickypedia · Jun 27, 2024 · 281142f · 281142f
1 parent 874b00e
commit 281142f
Show file tree

Hide file tree

Showing 48 changed files with 1,841 additions and 2,128 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <p align="center" style="text-align: center">
-  <img src="https://thevickypedia.github.io/open-source/images/logo/jarvis.png" width="371px" height="350px">
+  <img src="https://thevickypedia.github.io/open-source/images/logo/jarvis.png" width="371px" height="350px" alt="logo">
 </p>
 <h2 align="center">Voice-Activated Natural Language UI</h2>
 
@@ -56,9 +56,7 @@
 
 [![pages][label-actions-pages]][gha_pages]
 [![pypi][label-actions-pypi]][gha_pypi]
-
 [![markdown][label-actions-markdown]][gha_md_valid]
-[![cleanup][label-actions-cleanup]][gha_cleanup]
 
 [![Pypi][label-pypi]][pypi]
 [![Pypi-format][label-pypi-format]][pypi-files]
@@ -201,7 +199,6 @@ Licensed under the [MIT License][license]
 [gha_pages]: https://github.com/thevickypedia/Jarvis/actions/workflows/pages/pages-build-deployment
 [gha_pypi]: https://github.com/thevickypedia/Jarvis/actions/workflows/python-publish.yml
 [gha_md_valid]: https://github.com/thevickypedia/Jarvis/actions/workflows/markdown.yml
-[gha_cleanup]: https://github.com/thevickypedia/Jarvis/actions/workflows/cleanup.yml
 [webpage]: https://vigneshrao.com/
 [webpage_contact]: https://vigneshrao.com/contact
 [Anaconda]: https://docs.conda.io/projects/conda/en/latest/user-guide/install/
@@ -255,7 +252,6 @@ Licensed under the [MIT License][license]
 [label-actions-pages]: https://github.com/thevickypedia/Jarvis/actions/workflows/pages/pages-build-deployment/badge.svg
 [label-actions-pypi]: https://github.com/thevickypedia/Jarvis/actions/workflows/python-publish.yml/badge.svg
 [label-actions-markdown]: https://github.com/thevickypedia/Jarvis/actions/workflows/markdown.yml/badge.svg
-[label-actions-cleanup]: https://github.com/thevickypedia/Jarvis/actions/workflows/cleanup.yml/badge.svg
 
 [label-pypi]: https://img.shields.io/pypi/v/jarvis-ironman
 [label-pypi-format]: https://img.shields.io/pypi/format/jarvis-ironman

diff --git a/docs/README.html b/docs/README.html
@@ -44,7 +44,7 @@ <h3>Navigation</h3>
           <div class="body" role="main">
 
   <p align="center" style="text-align: center">
-  <img src="https://thevickypedia.github.io/open-source/images/logo/jarvis.png" width="371px" height="350px">
+  <img src="https://thevickypedia.github.io/open-source/images/logo/jarvis.png" width="371px" height="350px" alt="logo">
 </p>
 <h2 align="center">Voice-Activated Natural Language UI</h2><p><a class="reference external" href="https://python.org"><img alt="made-with-python" src="https://img.shields.io/badge/Made%20with-Python-blue?style=for-the-badge&amp;logo=Python" /></a></p>
 <p><img alt="Python" src="https://img.shields.io/badge/python-3.10%20%7C%203.11-orange" />
@@ -82,9 +82,8 @@ <h2 align="center">Voice-Activated Natural Language UI</h2><p><a class="referenc
 <img alt="Make" src="https://img.shields.io/github/search/thevickypedia/Jarvis/Makefile" /></p>
 <p><strong>Deployments</strong></p>
 <p><a class="reference external" href="https://github.com/thevickypedia/Jarvis/actions/workflows/pages/pages-build-deployment"><img alt="pages" src="https://github.com/thevickypedia/Jarvis/actions/workflows/pages/pages-build-deployment/badge.svg" /></a>
-<a class="reference external" href="https://github.com/thevickypedia/Jarvis/actions/workflows/python-publish.yml"><img alt="pypi" src="https://github.com/thevickypedia/Jarvis/actions/workflows/python-publish.yml/badge.svg" /></a></p>
-<p><a class="reference external" href="https://github.com/thevickypedia/Jarvis/actions/workflows/markdown.yml"><img alt="markdown" src="https://github.com/thevickypedia/Jarvis/actions/workflows/markdown.yml/badge.svg" /></a>
-<a class="reference external" href="https://github.com/thevickypedia/Jarvis/actions/workflows/cleanup.yml"><img alt="cleanup" src="https://github.com/thevickypedia/Jarvis/actions/workflows/cleanup.yml/badge.svg" /></a></p>
+<a class="reference external" href="https://github.com/thevickypedia/Jarvis/actions/workflows/python-publish.yml"><img alt="pypi" src="https://github.com/thevickypedia/Jarvis/actions/workflows/python-publish.yml/badge.svg" /></a>
+<a class="reference external" href="https://github.com/thevickypedia/Jarvis/actions/workflows/markdown.yml"><img alt="markdown" src="https://github.com/thevickypedia/Jarvis/actions/workflows/markdown.yml/badge.svg" /></a></p>
 <p><a class="reference external" href="https://pypi.org/project/jarvis-ironman"><img alt="Pypi" src="https://img.shields.io/pypi/v/jarvis-ironman" /></a>
 <a class="reference external" href="https://pypi.org/project/jarvis-ironman/#files"><img alt="Pypi-format" src="https://img.shields.io/pypi/format/jarvis-ironman" /></a>
 <a class="reference external" href="https://pypi.org/project/jarvis-ironman"><img alt="Pypi-status" src="https://img.shields.io/pypi/status/jarvis-ironman" /></a></p>

diff --git a/docs/README.md b/docs/README.md
@@ -1,5 +1,5 @@
 <p align="center" style="text-align: center">
-  <img src="https://thevickypedia.github.io/open-source/images/logo/jarvis.png" width="371px" height="350px">
+  <img src="https://thevickypedia.github.io/open-source/images/logo/jarvis.png" width="371px" height="350px" alt="logo">
 </p>
 <h2 align="center">Voice-Activated Natural Language UI</h2>
 
@@ -56,9 +56,7 @@
 
 [![pages][label-actions-pages]][gha_pages]
 [![pypi][label-actions-pypi]][gha_pypi]
-
 [![markdown][label-actions-markdown]][gha_md_valid]
-[![cleanup][label-actions-cleanup]][gha_cleanup]
 
 [![Pypi][label-pypi]][pypi]
 [![Pypi-format][label-pypi-format]][pypi-files]
@@ -201,7 +199,6 @@ Licensed under the [MIT License][license]
 [gha_pages]: https://github.com/thevickypedia/Jarvis/actions/workflows/pages/pages-build-deployment
 [gha_pypi]: https://github.com/thevickypedia/Jarvis/actions/workflows/python-publish.yml
 [gha_md_valid]: https://github.com/thevickypedia/Jarvis/actions/workflows/markdown.yml
-[gha_cleanup]: https://github.com/thevickypedia/Jarvis/actions/workflows/cleanup.yml
 [webpage]: https://vigneshrao.com/
 [webpage_contact]: https://vigneshrao.com/contact
 [Anaconda]: https://docs.conda.io/projects/conda/en/latest/user-guide/install/
@@ -255,7 +252,6 @@ Licensed under the [MIT License][license]
 [label-actions-pages]: https://github.com/thevickypedia/Jarvis/actions/workflows/pages/pages-build-deployment/badge.svg
 [label-actions-pypi]: https://github.com/thevickypedia/Jarvis/actions/workflows/python-publish.yml/badge.svg
 [label-actions-markdown]: https://github.com/thevickypedia/Jarvis/actions/workflows/markdown.yml/badge.svg
-[label-actions-cleanup]: https://github.com/thevickypedia/Jarvis/actions/workflows/cleanup.yml/badge.svg
 
 [label-pypi]: https://img.shields.io/pypi/v/jarvis-ironman
 [label-pypi-format]: https://img.shields.io/pypi/format/jarvis-ironman

diff --git a/docs/_sources/README.md.txt b/docs/_sources/README.md.txt
@@ -1,5 +1,5 @@
 <p align="center" style="text-align: center">
-  <img src="https://thevickypedia.github.io/open-source/images/logo/jarvis.png" width="371px" height="350px">
+  <img src="https://thevickypedia.github.io/open-source/images/logo/jarvis.png" width="371px" height="350px" alt="logo">
 </p>
 <h2 align="center">Voice-Activated Natural Language UI</h2>
 
@@ -56,9 +56,7 @@
 
 [![pages][label-actions-pages]][gha_pages]
 [![pypi][label-actions-pypi]][gha_pypi]
-
 [![markdown][label-actions-markdown]][gha_md_valid]
-[![cleanup][label-actions-cleanup]][gha_cleanup]
 
 [![Pypi][label-pypi]][pypi]
 [![Pypi-format][label-pypi-format]][pypi-files]
@@ -201,7 +199,6 @@ Licensed under the [MIT License][license]
 [gha_pages]: https://github.com/thevickypedia/Jarvis/actions/workflows/pages/pages-build-deployment
 [gha_pypi]: https://github.com/thevickypedia/Jarvis/actions/workflows/python-publish.yml
 [gha_md_valid]: https://github.com/thevickypedia/Jarvis/actions/workflows/markdown.yml
-[gha_cleanup]: https://github.com/thevickypedia/Jarvis/actions/workflows/cleanup.yml
 [webpage]: https://vigneshrao.com/
 [webpage_contact]: https://vigneshrao.com/contact
 [Anaconda]: https://docs.conda.io/projects/conda/en/latest/user-guide/install/
@@ -255,7 +252,6 @@ Licensed under the [MIT License][license]
 [label-actions-pages]: https://github.com/thevickypedia/Jarvis/actions/workflows/pages/pages-build-deployment/badge.svg
 [label-actions-pypi]: https://github.com/thevickypedia/Jarvis/actions/workflows/python-publish.yml/badge.svg
 [label-actions-markdown]: https://github.com/thevickypedia/Jarvis/actions/workflows/markdown.yml/badge.svg
-[label-actions-cleanup]: https://github.com/thevickypedia/Jarvis/actions/workflows/cleanup.yml/badge.svg
 
 [label-pypi]: https://img.shields.io/pypi/v/jarvis-ironman
 [label-pypi-format]: https://img.shields.io/pypi/format/jarvis-ironman

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -627,158 +627,181 @@ Word Match
    :members:
    :undoc-members:
 
-----------Modules----------
-===========================
-Audio
-=====
+----------Models----------
+==========================
 
-.. automodule:: jarvis.modules.audio.speaker
+Classes
+=======
+
+.. automodule:: jarvis.modules.models.classes
    :members:
-   :undoc-members:
+   :exclude-members: Settings, VehicleConnection, RecognizerSettings, BackgroundTask, EnvConfig, FileIO, Indicators, WiFiConnection, Thermostat
 
 ====
 
-.. automodule:: jarvis.modules.audio.listener
+.. autoclass:: jarvis.modules.models.classes.Settings(pydantic.BaseSettings)
    :members:
-   :undoc-members:
+   :exclude-members: _abc_impl, model_config, model_fields
 
 ====
 
-.. automodule:: jarvis.modules.audio.speech_synthesis
+.. autoclass:: jarvis.modules.models.classes.VehicleConnection(pydantic.BaseModel)
    :members:
-   :undoc-members:
+   :exclude-members: _abc_impl, model_config, model_fields
 
 ====
 
-.. automodule:: jarvis.modules.audio.tts_stt
+.. autoclass:: jarvis.modules.models.classes.RecognizerSettings(pydantic.BaseModel)
    :members:
-   :undoc-members:
+   :exclude-members: _abc_impl, model_config, model_fields
 
 ====
 
-.. automodule:: jarvis.modules.audio.voices
+.. autoclass:: jarvis.modules.models.classes.BackgroundTask(pydantic.BaseModel)
    :members:
-   :undoc-members:
+   :exclude-members: _abc_impl, model_config, model_fields
 
-Auth Bearer
-===========
+====
 
-.. automodule:: jarvis.modules.auth_bearer
+.. autoclass:: jarvis.modules.models.classes.EnvConfig(pydantic.BaseSettings)
    :members:
-   :undoc-members:
+   :exclude-members: _abc_impl, model_config, model_fields
 
-Built-In Overrides
-==================
+====
 
-.. automodule:: jarvis.modules.builtin_overrides
+.. autoclass:: jarvis.modules.models.classes.FileIO(pydantic.BaseModel)
    :members:
-   :undoc-members:
+   :exclude-members: _abc_impl, model_config, model_fields
 
-Cache - LRU
-===========
+====
 
-.. automodule:: jarvis.modules.cache.cache
+.. autoclass:: jarvis.modules.models.classes.Indicators(pydantic.BaseModel)
    :members:
-   :exclude-members:
+   :exclude-members: _abc_impl, model_config, model_fields
 
-Conditions
-==========
+====
 
-.. automodule:: jarvis.modules.conditions.conversation
+.. autoclass:: jarvis.modules.models.classes.WiFiConnection(pydantic.BaseModel)
    :members:
-   :exclude-members:
+   :exclude-members: _abc_impl, model_config, model_fields
 
 ====
 
-.. automodule:: jarvis.modules.conditions.keywords
+.. autoclass:: jarvis.modules.models.classes.Thermostat(pydantic.BaseModel)
    :members:
-   :exclude-members:
+   :exclude-members: _abc_impl, model_config, model_fields
 
-Crontab
-=======
+Enums
+=====
 
-.. automodule:: jarvis.modules.crontab.expression
+.. autoclass:: jarvis.modules.models.enums.SupportedPlatforms(Enum)
    :members:
-   :exclude-members:
+   :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_
 
-Classes
-=======
+====
 
-.. automodule:: jarvis.modules.models.classes
+.. autoclass:: jarvis.modules.models.enums.TemperatureUnits(Enum)
    :members:
-   :exclude-members: SupportedPlatforms, Settings, VehicleConnection, RecognizerSettings, TemperatureUnits, DistanceUnits, EventApp, SSQuality, BackgroundTask, EnvConfig, FileIO, Indicators
+   :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_
 
 ====
 
-.. autoclass:: jarvis.modules.models.classes.SupportedPlatforms(Enum)
+.. autoclass:: jarvis.modules.models.enums.DistanceUnits(Enum)
    :members:
    :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_
 
 ====
 
-.. autoclass:: jarvis.modules.models.classes.Settings(pydantic.BaseSettings)
+.. autoclass:: jarvis.modules.models.enums.EventApp(Enum)
    :members:
-   :exclude-members: _abc_impl, model_config, model_fields
+   :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_
 
 ====
 
-.. autoclass:: jarvis.modules.models.classes.VehicleConnection(pydantic.BaseModel)
+.. autoclass:: jarvis.modules.models.enums.SSQuality(Enum)
    :members:
-   :exclude-members: _abc_impl, model_config, model_fields
+   :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_
 
-====
+Models
+======
 
-.. autoclass:: jarvis.modules.models.classes.RecognizerSettings(pydantic.BaseModel)
+.. automodule:: jarvis.modules.models.models
    :members:
-   :exclude-members: _abc_impl, model_config, model_fields
+   :undoc-members:
 
-====
+----------Modules----------
+===========================
+Audio
+=====
 
-.. autoclass:: jarvis.modules.models.classes.TemperatureUnits(Enum)
+.. automodule:: jarvis.modules.audio.speaker
    :members:
-   :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_
+   :undoc-members:
 
 ====
 
-.. autoclass:: jarvis.modules.models.classes.DistanceUnits(Enum)
+.. automodule:: jarvis.modules.audio.listener
    :members:
-   :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_
+   :undoc-members:
 
 ====
 
-.. autoclass:: jarvis.modules.models.classes.EventApp(Enum)
+.. automodule:: jarvis.modules.audio.speech_synthesis
    :members:
-   :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_
+   :undoc-members:
 
 ====
 
-.. autoclass:: jarvis.modules.models.classes.SSQuality(Enum)
+.. automodule:: jarvis.modules.audio.tts_stt
    :members:
-   :exclude-members: _generate_next_value_, _member_names_, _member_map_, _member_type_, _value2member_map_
+   :undoc-members:
 
 ====
 
-.. autoclass:: jarvis.modules.models.classes.BackgroundTask(pydantic.BaseModel)
+.. automodule:: jarvis.modules.audio.voices
    :members:
-   :exclude-members: _abc_impl, model_config, model_fields
+   :undoc-members:
 
-====
+Auth Bearer
+===========
 
-.. autoclass:: jarvis.modules.models.classes.EnvConfig(pydantic.BaseSettings)
+.. automodule:: jarvis.modules.auth_bearer
    :members:
-   :exclude-members: _abc_impl, model_config, model_fields
+   :undoc-members:
 
-====
+Built-In Overrides
+==================
 
-.. autoclass:: jarvis.modules.models.classes.FileIO(pydantic.BaseModel)
+.. automodule:: jarvis.modules.builtin_overrides
    :members:
-   :exclude-members: _abc_impl, model_config, model_fields
+   :undoc-members:
+
+Cache - LRU
+===========
+
+.. automodule:: jarvis.modules.cache.cache
+   :members:
+   :exclude-members:
+
+Conditions
+==========
+
+.. automodule:: jarvis.modules.conditions.conversation
+   :members:
+   :exclude-members:
 
 ====
 
-.. autoclass:: jarvis.modules.models.classes.Indicators(pydantic.BaseModel)
+.. automodule:: jarvis.modules.conditions.keywords
    :members:
-   :exclude-members: _abc_impl, model_config, model_fields
+   :exclude-members:
+
+Crontab
+=======
+
+.. automodule:: jarvis.modules.crontab.expression
+   :members:
+   :exclude-members:
 
 Database
 ========
@@ -858,13 +881,6 @@ Meetings
    :members:
    :undoc-members:
 
-Models
-======
-
-.. automodule:: jarvis.modules.models.models
-   :members:
-   :undoc-members:
-
 Retry Handler
 =============