inspy-logger 3.0.dev5__tar.gz → 3.0.2__tar.gz

{inspy_logger-3.0.dev5 → inspy_logger-3.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: inspy-logger
-Version: 3.0.dev5
+Version: 3.0.2
 Summary: Colorable, scalable logger for CLI
 Home-page: https://github.com/Inspyre-Softworks/inSPy-Logger
 License: MIT
@@ -32,7 +32,7 @@ Requires-Dist: luddite (>=1.0.1,<2.0.0)
 Requires-Dist: packaging (>=21.0,<22.0)
 Requires-Dist: python-box (>=6.1.0,<7.0.0)
 Requires-Dist: requests (>=2.28.1,<3.0.0)
-Requires-Dist: rich (>=13.5.2,<14.0.0)
+Requires-Dist: rich (>=13.7.0,<14.0.0)
 Requires-Dist: setuptools-autover (>=1.0.2,<2.0.0)
 Project-URL: Documentation, https://inspy-logger.readthedocs.io/en/latest/
 Project-URL: Repository, https://github.com/Inspyre-Softworks/inSPy-Logger

inspy_logger-3.0.2/inspy_logger/Scripts/main.py

@@ -0,0 +1,98 @@
+"""
+
+File: 
+    inspy_logger/Scripts/main.py
+
+Author: 
+    Inspyre Softworks
+    
+"""
+INSPY_LOG_LEVEL = 'info'
+
+PROGNAME = 'inspy-logger-tool'
+
+from argparse import ArgumentParser
+
+from inspy_logger.helpers.debug.environment import fetch_system_info
+from inspy_logger.version import parse_version, PyPiVersionInfo
+
+# ---- SET UP PARSER --------------------------------
+
+parser = ArgumentParser('inspy-logger-version', description='Displays version information for inspy-logger.')
+
+parser.add_argument('-v', '--version', action='version', version=parse_version())
+
+# ---- SET UP SUBPARSERS --------------------------------
+
+subparsers = parser.add_subparsers(title='subcommands', dest='subcommand')
+
+# ---- UPDATE COMMAND --------------------------------
+
+update_parser =subparsers.add_parser('update', help='Checks for updates to inspy-logger.')
+
+update_parser.add_argument('-p', '--pre-release', action='store_true', help='When checking for updates, include pre-release versions.')
+
+# ---- DEBUG COMMAND --------------------------------
+
+debug_parser = subparsers.add_parser('debug', help='Fetches a collection of  environment information to help debug inspy-logger.')
+
+debug_parser.add_argument('-C', '--copy-to-clipboard', action='store_true', help='Copies the debug information to the clipboard.')
+debug_parser.add_argument('-P', '--print', action='store_true', help='Prints the debug information to the console.', default=True)
+
+# ---- FORMAT FLAGS --------------------------------
+
+fmt_grp = debug_parser.add_mutually_exclusive_group()
+
+fmt_grp.add_argument('-M', '--markdown', action='store_true', help='Formats the debug information in Markdown.')
+
+fmt_grp.add_argument('-J', '--json', action='store_true', help='Formats the debug information in JSON.')
+
+fmt_grp.add_argument('-T', '--text', action='store_true', help='Formats the debug information in plain text.')
+
+# Parse the arguments
+parsed_args = parser.parse_args()
+
+# END PARSER SETUP
+
+if parsed_args.subcommand == 'update':
+    INCLUDE_PRE_RELEASE_FOR_UPDATE_CHECK = parsed_args.pre_release
+else:
+    INCLUDE_PRE_RELEASE_FOR_UPDATE_CHECK = False
+
+
+def main():
+
+    version = PyPiVersionInfo()
+
+    ACTIONS = {
+        'default': version.print_version_info,
+        'update': version.update,
+        'debug': fetch_system_info,
+
+    }
+
+    if parsed_args.subcommand is None:
+        parsed_args.subcommand = 'default'
+
+    if parsed_args.subcommand == 'debug':
+
+        if (
+            parsed_args.markdown
+            or not parsed_args.json
+            and not parsed_args.text
+        ):
+            fmt = 'markdown'
+        elif parsed_args.json:
+            fmt = 'json'
+        else:
+            fmt = 'text'
+
+        fetch_system_info(copy_to_clipboard=parsed_args.copy_to_clipboard, format_type=fmt, print_to_console=parsed_args.print)
+
+
+
+
+    return parsed_args
+
+if __name__ == '__main__':
+    main()

{inspy_logger-3.0.dev5 → inspy_logger-3.0.2}/inspy_logger/__about__.py

@@ -11,24 +11,13 @@ Since:
     v2.1.1
 
 """
+from typing import List, Tuple
+
 from inspy_logger.version import parse_version
 
-__prog__ = 'inSPy-Logger'
-__version__ = parse_version()
-__authors__ = [
+__PROG__ = 'inSPy-Logger'
+__VERSION__: str = parse_version()
+__AUTHORS__: list[tuple[str, str]] = [
         ('Inspyre-Softworks', 'https://inspyre.tech'),
         ('Taylor-Jayde Blackstone', '<t.blackstone@inspyre.tech')
 ]
-
-'''
-File Change History:
-11/5/22 - 4:21 AM (v2.1.2):
-  -  Added description to docstring. (target: 2.1.2)
- 
-11/5/22 - 4:41 AM:
-  - Version bump (target: 2.1.3)
-  
-08/16/2023 - 13:49 (v3.0):
-  - Version bump (v2.1.3 -> v3.0-dev.1)
-
-'''

inspy_logger-3.0.2/inspy_logger/__init__.py

@@ -0,0 +1,75 @@
+#!/usr/bin/env python3
+import sys
+from inspy_logger.common import PROG_NAME, DEFAULT_LOGGING_LEVEL
+from inspy_logger.helpers import find_variable_in_call_stack, check_preemptive_level_set, find_argument_parser
+
+
+from inspy_logger.helpers import (
+    translate_to_logging_level,
+    clean_module_name,
+    CustomFormatter,
+    determine_client_prog_name,
+)
+
+from inspy_logger.engine import Logger
+
+__all__ = [
+    "PROG_NAME",
+    "DEFAULT_LOGGING_LEVEL",
+    "translate_to_logging_level",
+    "clean_module_name",
+    "CustomFormatter",
+    "Logger",
+    "LOG_DEVICE",
+    "client_prog_name",
+    "determine_level"
+]
+
+LOG_DEVICE = Logger(PROG_NAME)
+
+MODULE_OBJ = sys.modules[__name__]
+
+client_prog_name = determine_client_prog_name()
+
+
+
+def determine_level():
+    """
+    Determines the level at which to output logs to the console.
+
+    Returns:
+        int:
+            The level at which to output logs to the console.
+    """
+    global client_prog_name
+    level = DEFAULT_LOGGING_LEVEL
+
+    _preemptive_set = check_preemptive_level_set()
+
+    if _preemptive_set:
+        level = translate_to_logging_level(_preemptive_set)
+
+    if client_prog_name:
+        arg_parser = find_argument_parser()
+        if arg_parser:
+            from inspy_logger.helpers.command_line import add_argument
+            add_argument(arg_parser, level)
+            args = arg_parser.parse_args()
+
+            level = translate_to_logging_level(args.log_level)
+
+    return level
+
+
+LOG_DEVICE.set_level(determine_level())
+
+
+if client_prog_name:
+    PROG_LOGGER = Logger(client_prog_name, LOG_DEVICE.console_level, LOG_DEVICE.file_level)
+    __all__.append('PROG_LOGGER')
+
+
+InspyLogger = Logger
+
+
+LOG_DEVICE.replay_and_setup_handlers()

inspy_logger-3.0.2/inspy_logger/common/__init__.py

@@ -0,0 +1,36 @@
+import logging
+
+from inspy_logger.__about__ import __PROG__ as PROG_NAME, __VERSION__ as PROG_VERSION
+
+
+__all__ = [
+    "PROG_NAME",
+    "PROG_VERSION",
+    "LEVEL_MAP",
+    "LEVELS",
+    "DEFAULT_LOGGING_LEVEL",
+    "InspyLogger"
+]
+
+
+LEVEL_MAP = {
+    'debug': logging.DEBUG,
+    'info': logging.INFO,
+    'warning': logging.WARNING,
+    'error': logging.ERROR,
+    'critical': logging.CRITICAL,
+    'fatal': logging.FATAL,
+}
+"""A mapping of level names to their corresponding logging levels."""
+
+
+LEVELS = list(LEVEL_MAP.values())
+"""The list of level names."""
+
+
+DEFAULT_LOGGING_LEVEL = logging.DEBUG
+"""The default logging level."""
+
+
+class InspyLogger:
+    pass