Skip to content

Merge the Prototype branch into the Master branch #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emvaldes merged 4 commits into from
Mar 10, 2025
Merged

Merge the Prototype branch into the Master branch #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4e2cb26
Completed partial integration with pydoc engine
emvaldes Mar 10, 2025
89478ef
Completed the packages integration with pydocs
emvaldes Mar 10, 2025
d4738fc
I will stop any further develpment at this point
emvaldes Mar 10, 2025
b6b70d2
Minor updates to this project
emvaldes Mar 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added .coverage.emvaldes-imac-desktop.local.22118.XTRkvoox
View file
Open in desktop
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/coverage/lib/pydoc_generator.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
----------------------------------------------------------
lib/pydoc_generator.py 86 60 10 3 28%
lib/pydoc_generator.py 86 45 10 1 46%
----------------------------------------------------------
TOTAL 86 60 10 3 28%
TOTAL 86 45 10 1 46%
4 changes: 2 additions & 2 deletions docs/coverage/lib/system_variables.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
-----------------------------------------------------------
lib/system_variables.py 19 19 0 0 0%
lib/system_variables.py 22 22 0 0 0%
-----------------------------------------------------------
TOTAL 19 19 0 0 0%
TOTAL 22 22 0 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/lib/timezone_localoffset.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
---------------------------------------------------------------
lib/timezone_localoffset.py 43 43 4 0 0%
lib/timezone_localoffset.py 42 42 4 0 0%
---------------------------------------------------------------
TOTAL 43 43 4 0 0%
TOTAL 42 42 4 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/__init__.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
--------------------------------------------------------
packages/__init__.py 2 2 0 0 0%
packages/__init__.py 6 6 0 0 0%
--------------------------------------------------------
TOTAL 2 2 0 0 0%
TOTAL 6 6 0 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/appflow_tracer/__init__.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
-----------------------------------------------------------------------
packages/appflow_tracer/__init__.py 5 5 0 0 0%
packages/appflow_tracer/__init__.py 9 9 0 0 0%
-----------------------------------------------------------------------
TOTAL 5 5 0 0 0%
TOTAL 9 9 0 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/appflow_tracer/__main__.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
-----------------------------------------------------------------------
packages/appflow_tracer/__main__.py 5 5 2 0 0%
packages/appflow_tracer/__main__.py 9 9 2 0 0%
-----------------------------------------------------------------------
TOTAL 5 5 2 0 0%
TOTAL 9 9 2 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/appflow_tracer/lib/__init__.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
---------------------------------------------------------------------------
packages/appflow_tracer/lib/__init__.py 4 4 0 0 0%
packages/appflow_tracer/lib/__init__.py 8 8 0 0 0%
---------------------------------------------------------------------------
TOTAL 4 4 0 0 0%
TOTAL 8 8 0 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/appflow_tracer/lib/file_utils.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
-----------------------------------------------------------------------------
packages/appflow_tracer/lib/file_utils.py 42 42 12 0 0%
packages/appflow_tracer/lib/file_utils.py 48 48 14 0 0%
-----------------------------------------------------------------------------
TOTAL 42 42 12 0 0%
TOTAL 48 48 14 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/appflow_tracer/lib/log_utils.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
----------------------------------------------------------------------------
packages/appflow_tracer/lib/log_utils.py 39 27 24 6 29%
packages/appflow_tracer/lib/log_utils.py 46 34 26 6 25%
----------------------------------------------------------------------------
TOTAL 39 27 24 6 29%
TOTAL 46 34 26 6 25%
4 changes: 2 additions & 2 deletions docs/coverage/packages/appflow_tracer/lib/serialize_utils.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
----------------------------------------------------------------------------------
packages/appflow_tracer/lib/serialize_utils.py 41 41 12 0 0%
packages/appflow_tracer/lib/serialize_utils.py 48 48 14 0 0%
----------------------------------------------------------------------------------
TOTAL 41 41 12 0 0%
TOTAL 48 48 14 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/appflow_tracer/lib/trace_utils.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
------------------------------------------------------------------------------
packages/appflow_tracer/lib/trace_utils.py 116 116 44 0 0%
packages/appflow_tracer/lib/trace_utils.py 123 123 46 0 0%
------------------------------------------------------------------------------
TOTAL 116 116 44 0 0%
TOTAL 123 123 46 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/appflow_tracer/tracing.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
----------------------------------------------------------------------
packages/appflow_tracer/tracing.py 86 80 28 1 6%
packages/appflow_tracer/tracing.py 88 82 28 1 6%
----------------------------------------------------------------------
TOTAL 86 80 28 1 6%
TOTAL 88 82 28 1 6%
4 changes: 2 additions & 2 deletions docs/coverage/packages/requirements/__init__.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
---------------------------------------------------------------------
packages/requirements/__init__.py 4 4 0 0 0%
packages/requirements/__init__.py 8 8 0 0 0%
---------------------------------------------------------------------
TOTAL 4 4 0 0 0%
TOTAL 8 8 0 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/requirements/__main__.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
---------------------------------------------------------------------
packages/requirements/__main__.py 5 5 2 0 0%
packages/requirements/__main__.py 9 9 2 0 0%
---------------------------------------------------------------------
TOTAL 5 5 2 0 0%
TOTAL 9 9 2 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/requirements/dependencies.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
-------------------------------------------------------------------------
packages/requirements/dependencies.py 69 69 18 0 0%
packages/requirements/dependencies.py 71 71 18 0 0%
-------------------------------------------------------------------------
TOTAL 69 69 18 0 0%
TOTAL 71 71 18 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/requirements/lib/__init__.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
-------------------------------------------------------------------------
packages/requirements/lib/__init__.py 3 3 0 0 0%
packages/requirements/lib/__init__.py 8 8 0 0 0%
-------------------------------------------------------------------------
TOTAL 3 3 0 0 0%
TOTAL 8 8 0 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/requirements/lib/brew_utils.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
---------------------------------------------------------------------------
packages/requirements/lib/brew_utils.py 90 90 30 0 0%
packages/requirements/lib/brew_utils.py 97 97 32 0 0%
---------------------------------------------------------------------------
TOTAL 90 90 30 0 0%
TOTAL 97 97 32 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/requirements/lib/package_utils.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
------------------------------------------------------------------------------
packages/requirements/lib/package_utils.py 181 181 54 0 0%
packages/requirements/lib/package_utils.py 187 187 56 0 0%
------------------------------------------------------------------------------
TOTAL 181 181 54 0 0%
TOTAL 187 187 56 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/requirements/lib/policy_utils.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
-----------------------------------------------------------------------------
packages/requirements/lib/policy_utils.py 65 65 18 0 0%
packages/requirements/lib/policy_utils.py 72 72 20 0 0%
-----------------------------------------------------------------------------
TOTAL 65 65 18 0 0%
TOTAL 72 72 20 0 0%
4 changes: 2 additions & 2 deletions docs/coverage/packages/requirements/lib/version_utils.coverage
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Name Stmts Miss Branch BrPart Cover
------------------------------------------------------------------------------
packages/requirements/lib/version_utils.py 119 119 32 0 0%
packages/requirements/lib/version_utils.py 126 126 34 0 0%
------------------------------------------------------------------------------
TOTAL 119 119 32 0 0%
TOTAL 126 126 34 0 0%
33 changes: 21 additions & 12 deletions docs/pydoc/lib/__init__.pydoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,41 @@
Help on module lib.__init__ in lib:

NAME
lib.__init__
lib.__init__ - File Path: ./lib/__init__.py

DESCRIPTION
Overview:
The __init__.py file is responsible for marking the 'lib' directory as a Python package,
allowing its modules to be imported properly within the project.
The __init__.py file initializes the 'lib' directory as a Python package,
enabling structured imports for internal modules.

This file serves as the entry point for the 'lib' package and may include shared imports,
initialization logic, or package-wide configuration settings.
Purpose:
- Ensures the directory is recognized as a Python package.
- Provides a centralized location for shared configurations or imports.
- Dynamically loads external documentation to maintain code clarity.

Core Features:
- Package Initialization: Ensures 'lib' is recognized as a Python package.
- Shared Module Accessibility: Provides a central location for utility imports.
- Extensibility: Can be modified to include package-wide configurations if necessary.
- **Package Initialization**: Marks 'lib' as an importable package.
- **Dynamic Documentation Loading**: Uses 'pydoc_loader' to apply docstrings at runtime.
- **Shared Path Handling**: Adds the package directory to `sys.path` for accessibility.
- **Minimal Overhead**: Avoids automatic imports of all submodules unless explicitly required.

Expected Behavior & Usage:
Importing Modules from 'lib':
from lib import system_variables, file_utils

Example Integration:
from lib import log_utils
log_utils.log_message("Initialization successful.")
Using a Specific Submodule:
from lib.log_utils import log_message
log_message("Initialization successful.")

Dynamically Applying Documentation:
from lib.pydoc_loader import load_pydocs
load_pydocs(__file__, sys.modules[__name__])

Important Notes:
- This file does not automatically import all submodules to prevent unnecessary overhead.
- This file **does not** automatically import all submodules to prevent unnecessary overhead.
- Individual submodules must be explicitly imported when required.
- The `sys.path.insert()` modification ensures package accessibility but should not be removed unless explicitly handled elsewhere.
- Future extensions may include package-wide constants, configurations, or logging initialization.

VERSION
0.1.0
Expand Down
Loading