inspy-logger 3.1.0.dev2__tar.gz → 3.1.0.dev4__tar.gz

{inspy_logger-3.1.0.dev2 → inspy_logger-3.1.0.dev4}/LICENSE.md

@@ -1,20 +1,20 @@
-### Do What the Fuck You Want To - Public License (v3.0 3, Sept. 2020)
-----
-----
-
-                    Copyright (C) 2020 Taylor-Jayde Blackstone <t.blackstone@inspyre.tech>
-
-----
-
- Everyone is permitted to copy and distribute verbatim or modified
- copies of this license document, and changing it is allowed as long
- as the name is changed. That's my name, you can't have it.
-            
-                                  DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
-                        TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
-
-- You just **DO WHAT THE FUCK YOU WANT TO**.
-- You **don't** blame me for **shit**. _I don't care_ how much smoke your hard-drive spewed out.
-- If someone else did what the fuck they wanted to and you're _**triggered**_ I'm **not** responsible.
-
-                              Contact <dev.null@inspyre.tech> with any complaints.
+### Do What the Fuck You Want To - Public License (v3.0 3, Sept. 2020)
+----
+----
+
+                    Copyright (C) 2020 Taylor-Jayde Blackstone <t.blackstone@inspyre.tech>
+
+----
+
+ Everyone is permitted to copy and distribute verbatim or modified
+ copies of this license document, and changing it is allowed as long
+ as the name is changed. That's my name, you can't have it.
+            
+                                  DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                        TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+- You just **DO WHAT THE FUCK YOU WANT TO**.
+- You **don't** blame me for **shit**. _I don't care_ how much smoke your hard-drive spewed out.
+- If someone else did what the fuck they wanted to and you're _**triggered**_ I'm **not** responsible.
+
+                              Contact <dev.null@inspyre.tech> with any complaints.

{inspy_logger-3.1.0.dev2 → inspy_logger-3.1.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: inspy-logger
-Version: 3.1.0.dev2
+Version: 3.1.0.dev4
 Summary: Colorable, scalable logger for CLI
 Home-page: https://github.com/Inspyre-Softworks/inSPy-Logger
 License: MIT
@@ -32,6 +32,7 @@ Requires-Dist: luddite (>=1.0.4,<2.0.0)
 Requires-Dist: packaging (>=24.0,<25.0)
 Requires-Dist: platformdirs (>=4.2.0,<5.0.0)
 Requires-Dist: pypattyrn (>=1.2,<2.0)
+Requires-Dist: pyperclip (>=1.8.2,<2.0.0)
 Requires-Dist: python-box (>=7.1.1,<8.0.0)
 Requires-Dist: requests (>=2.28.1,<3.0.0)
 Requires-Dist: rich (>=13.7.0,<14.0.0)

{inspy_logger-3.1.0.dev2 → inspy_logger-3.1.0.dev4}/README.md

@@ -1,54 +1,54 @@
-# inSPy-Logger
-![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Inspyre-Softworks/inSPy-Logger/CI?label=CI&logo=github&logoColor=9cf&style=for-the-badge) 
-![Codacy grade](https://img.shields.io/codacy/grade/7171eec682c549a88dee0da9cc9b92b3?logo=codacy&logoColor=9cf&style=for-the-badge) 
-![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/Inspyre-Softworks/inSPy-Logger?color=9cf&include_prereleases&label=Pre-Release&logo=pypi&logoColor=9cf&style=for-the-badge) 
-![PyPI](https://img.shields.io/pypi/v/inspy-logger?color=9cf&label=Latest&logo=pypi&logoColor=9cf&style=for-the-badge) 
-![GitHub issues](https://img.shields.io/github/issues/Inspyre-Softworks/inSPy-Logger?color=9cf&logo=github&logoColor=9cf&style=for-the-badge) 
-![PyPI - Format](https://img.shields.io/pypi/format/inSPy-Logger?logo=PyPi&style=for-the-badge)
-
-## Installation
-
-### Prerequisites:
-
-**Platform/Env**:
-  * **Python**: ^3.6.3
-  * **PIP**: (_If you want to install via PIP, that is_)
-  
-**inSPy-Logger Runtime Dependencies**:
-  I am providing this list of dependencies for transparency and for instances where one would not be able to install inSPy-Logger via PyPi's package manager. It is **highly** recommended you use `python3 -m pip install inspy_logger==<ver>` to install inSPy-Logger 2.0+
-  
-  * [colorlog](https://pypi.org/project/colorlog) (^4.2.1)
-  * [setuptools-autover](https://pypi.org/project/setuptools-autover) = (^1.0.2)
-  * [luddite](https://pypi.org/project/luddite) = (^1.0.1)
-  * [packaging](https://pypi.org/project/packaging) = (^20.4)
-
-### Installation via Pip on Python 3.6.3+ (recommended method):
-
-- `$> python3 -m pip install inspy_logger==<version>`
-
-#### Test out InspyLogger:
-
-```python3
-
-import inspy_logger
-
-# Set up a log device object. The first parameter is the root loggers name, and the second is the debug level
-log_device = inspy_logger.InspyLogger('LogName', 'debug')
-
-# Start a running log from that device
-log = log_device.start()
-
-# Output our own logger lines:
-log.debug('This is a debug log entry')
-log.info('This is an info log entry')
-log.warning('This is a warning log entry!')
-log.error('This is an error log entry!')
-log.exception('This is an exception log entry!')
-
-```
-
-If you run the code above you'll get output similar to this:
-
-![output1](https://github.com/Inspyre-Softworks/inSPy-Logger/blob/v2.0-alpha.6/examples/v2.0/output_screenies/v2.0.0a.6_screenie1.png)
-
-v2.0+ repository for inSPy-Logger
+# inSPy-Logger
+![GitHub Workflow Status](https://img.shields.io/github/workflow/status/Inspyre-Softworks/inSPy-Logger/CI?label=CI&logo=github&logoColor=9cf&style=for-the-badge) 
+![Codacy grade](https://img.shields.io/codacy/grade/7171eec682c549a88dee0da9cc9b92b3?logo=codacy&logoColor=9cf&style=for-the-badge) 
+![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/Inspyre-Softworks/inSPy-Logger?color=9cf&include_prereleases&label=Pre-Release&logo=pypi&logoColor=9cf&style=for-the-badge) 
+![PyPI](https://img.shields.io/pypi/v/inspy-logger?color=9cf&label=Latest&logo=pypi&logoColor=9cf&style=for-the-badge) 
+![GitHub issues](https://img.shields.io/github/issues/Inspyre-Softworks/inSPy-Logger?color=9cf&logo=github&logoColor=9cf&style=for-the-badge) 
+![PyPI - Format](https://img.shields.io/pypi/format/inSPy-Logger?logo=PyPi&style=for-the-badge)
+
+## Installation
+
+### Prerequisites:
+
+**Platform/Env**:
+  * **Python**: ^3.6.3
+  * **PIP**: (_If you want to install via PIP, that is_)
+  
+**inSPy-Logger Runtime Dependencies**:
+  I am providing this list of dependencies for transparency and for instances where one would not be able to install inSPy-Logger via PyPi's package manager. It is **highly** recommended you use `python3 -m pip install inspy_logger==<ver>` to install inSPy-Logger 2.0+
+  
+  * [colorlog](https://pypi.org/project/colorlog) (^4.2.1)
+  * [setuptools-autover](https://pypi.org/project/setuptools-autover) = (^1.0.2)
+  * [luddite](https://pypi.org/project/luddite) = (^1.0.1)
+  * [packaging](https://pypi.org/project/packaging) = (^20.4)
+
+### Installation via Pip on Python 3.6.3+ (recommended method):
+
+- `$> python3 -m pip install inspy_logger==<version>`
+
+#### Test out InspyLogger:
+
+```python3
+
+import inspy_logger
+
+# Set up a log device object. The first parameter is the root loggers name, and the second is the debug level
+log_device = inspy_logger.InspyLogger('LogName', 'debug')
+
+# Start a running log from that device
+log = log_device.start()
+
+# Output our own logger lines:
+log.debug('This is a debug log entry')
+log.info('This is an info log entry')
+log.warning('This is a warning log entry!')
+log.error('This is an error log entry!')
+log.exception('This is an exception log entry!')
+
+```
+
+If you run the code above you'll get output similar to this:
+
+![output1](https://github.com/Inspyre-Softworks/inSPy-Logger/blob/v2.0-alpha.6/examples/v2.0/output_screenies/v2.0.0a.6_screenie1.png)
+
+v2.0+ repository for inSPy-Logger

{inspy_logger-3.1.0.dev2 → inspy_logger-3.1.0.dev4}/inspy_logger/__about__.py

@@ -1,24 +1,24 @@
-"""
-
-File: inspy_logger/__about__.py
-Project: inSPy-Logger
-Description:
-    Holds information about the inSPy-Logger program and its version.
-
-Created: 11/3/22 - 21:05:06
-
-Since:
-    v2.1.1
-
-"""
-
-from inspy_logger.version import parse_version
-
-__PROG__ = 'inSPy-Logger'
-__VERSION__: str = parse_version()
-__AUTHORS__: list[tuple[str, str]] = [
-        ('Inspyre-Softworks', 'https://inspyre.tech'),
-        ('Taylor-Jayde Blackstone', '<t.blackstone@inspyre.tech')
-]
-
-SOFTWARE_ORG = __AUTHORS__[0][0]
+"""
+
+File: inspy_logger/__about__.py
+Project: inSPy-Logger
+Description:
+    Holds information about the inSPy-Logger program and its version.
+
+Created: 11/3/22 - 21:05:06
+
+Since:
+    v2.1.1
+
+"""
+
+from inspy_logger.version import parse_version
+
+__PROG__ = 'inSPy-Logger'
+__VERSION__: str = parse_version()
+__AUTHORS__: list[tuple[str, str]] = [
+        ('Inspyre-Softworks', 'https://inspyre.tech'),
+        ('Taylor-Jayde Blackstone', '<t.blackstone@inspyre.tech')
+]
+
+SOFTWARE_ORG = __AUTHORS__[0][0]

{inspy_logger-3.1.0.dev2 → inspy_logger-3.1.0.dev4}/inspy_logger/__init__.py

@@ -1,135 +1,137 @@
-#!/usr/bin/env python3
-import contextlib
-import sys
-import inspect
-import logging
-from pypattyrn.behavioral.null import Null
-from inspy_logger.common import PROG_NAME as ISL_PROG_NAME, DEFAULT_LOGGING_LEVEL, DEFAULT_LOG_FILE_PATH, LEVELS
-from inspy_logger.helpers import find_variable_in_call_stack, check_preemptive_level_set, find_argument_parser, determine_start_block, determine_level
-
-from inspy_logger.helpers import (
-    translate_to_logging_level,
-    clean_module_name,
-    CustomFormatter,
-    determine_client_prog_name,
-    determine_log_file_path
-)
-
-# Existing log record factory
-old_factory = logging.getLogRecordFactory()
-
-
-def record_factory(*args, **kwargs):
-    record = old_factory(*args, **kwargs)
-    # Set the file_name attribute to the name of the file where the log is called
-    frame = inspect.stack()[1]
-    record.file_name = frame.filename
-    return record
-
-
-logging.setLogRecordFactory(record_factory)
-
-
-from inspy_logger.engine import Logger
-
-__all__ = [
-    "clean_module_name",
-    "CustomFormatter",
-    "DEFAULT_LOGGING_LEVEL",
-    "determine_level",
-    "InspyLogger",
-    "LOG_DEVICE",
-    "Logger",
-    "ISL_PROG_NAME",
-    "translate_to_logging_level",
-]
-
-BLOCKED = determine_start_block()
-
-LOG_FILE = determine_log_file_path()
-
-LOG_DEVICE = None if BLOCKED else Logger(ISL_PROG_NAME)
-
-MODULE_OBJ = sys.modules[__name__]
-
-CLIENT_PROG_NAME = determine_client_prog_name()
-
-INIT_LOG_LEVEL = determine_level(CLIENT_PROG_NAME)
-
-
-def start_logger(override_block=True):
-    """
-    Starts the logger.
-
-    Parameters:
-        override_block (Union[bool, None], optional):
-            A flag to override the block on the logger. Defaults to True.
-
-    Note:
-        You only need to run this function if you have blocked the logger from starting automatically.
-
-    Returns:
-
-    """
-    global LOG_DEVICE
-    global CLIENT_PROG_NAME
-    global INIT_LOG_LEVEL
-
-    if not BLOCKED or override_block:
-        LOG_DEVICE = Logger(ISL_PROG_NAME)
-        LOG_DEVICE.set_level(INIT_LOG_LEVEL)
-
-        if CLIENT_PROG_NAME:
-
-            prog_logger = Logger(
-                CLIENT_PROG_NAME,
-                LOG_DEVICE.console_level,
-                LOG_DEVICE.file_level,
-                file_name=DEFAULT_LOG_FILE_PATH.name,
-                file_path=DEFAULT_LOG_FILE_PATH.parent
-            )
-            __all__.append('PROG_LOGGER')
-
-        LOG_DEVICE.replay_and_setup_handlers()
-    elif CLIENT_PROG_NAME:
-        prog_logger = Null()
-
-    with contextlib.suppress(NameError):
-        global PROG_LOGGER
-
-        PROG_LOGGER = prog_logger
-
-        if isinstance(PROG_LOGGER, Null):
-            from rich import print
-            print("The logger has been blocked from starting. To start the logger, run `start_logger()`.")
-        
-
-InspyLogger = Logger
-
-
-def _get_loggable():
-    from inspy_logger.helpers.base_classes import Loggable
-    import bisect
-    # Add the `Loggable` class to `__all__` in alphabetical order.
-    bisect.insort(__all__, 'Loggable')
-
-    return Loggable
-
-
-Loggable = _get_loggable()
-
-
-start_logger(override_block=False)
-
-
-deprecation_warning_deliveries = 0
-
-
-def getLogger(*args, **kwargs):
-    global deprecation_warning_deliveries
-
-    if deprecation_warning_deliveries < 5:
-        LOG_DEVICE.warning('The `getLogger` function is deprecated. Use `InspyLogger` instead.')
-        deprecation_warning_deliveries += 1
-
-    return InspyLogger(*args, **kwargs)
+#!/usr/bin/env python3
+import contextlib
+import sys
+import inspect
+import logging
+from pypattyrn.behavioral.null import Null
+from inspy_logger.common import PROG_NAME as ISL_PROG_NAME, DEFAULT_LOGGING_LEVEL, DEFAULT_LOG_FILE_PATH, LEVELS
+from inspy_logger.helpers import find_variable_in_call_stack, check_preemptive_level_set, find_argument_parser, determine_start_block, determine_level
+
+from inspy_logger.helpers import (
+    translate_to_logging_level,
+    clean_module_name,
+    CustomFormatter,
+    determine_client_prog_name,
+    determine_log_file_path
+)
+
+# Existing log record factory
+old_factory = logging.getLogRecordFactory()
+
+
+def record_factory(*args, **kwargs):
+    record = old_factory(*args, **kwargs)
+    # Set the file_name attribute to the name of the file where the log is called
+    frame = inspect.stack()[1]
+    record.file_name = frame.filename
+    return record
+
+
+logging.setLogRecordFactory(record_factory)
+
+
+from inspy_logger.engine import Logger
+
+__all__ = [
+    "clean_module_name",
+    "CustomFormatter",
+    "DEFAULT_LOGGING_LEVEL",
+    "determine_level",
+    "InspyLogger",
+    "LOG_DEVICE",
+    "Logger",
+    "ISL_PROG_NAME",
+    "translate_to_logging_level",
+]
+
+BLOCKED = determine_start_block()
+
+LOG_FILE = determine_log_file_path()
+
+LOG_DEVICE = None if BLOCKED else Logger(ISL_PROG_NAME)
+
+MODULE_OBJ = sys.modules[__name__]
+
+CLIENT_PROG_NAME = determine_client_prog_name()
+
+INIT_LOG_LEVEL = determine_level(CLIENT_PROG_NAME)
+
+INTERACTIVE_SESSION = find_variable_in_call_stack('INSPY_INTERACTIVE_SESSION', default=False)
+
+
+def start_logger(override_block=True):
+    """
+    Starts the logger.
+
+    Parameters:
+        override_block (Union[bool, None], optional):
+            A flag to override the block on the logger. Defaults to True.
+
+    Note:
+        You only need to run this function if you have blocked the logger from starting automatically.
+
+    Returns:
+
+    """
+    global LOG_DEVICE
+    global CLIENT_PROG_NAME
+    global INIT_LOG_LEVEL
+
+    if not BLOCKED or override_block:
+        LOG_DEVICE = Logger(ISL_PROG_NAME)
+        LOG_DEVICE.set_level(INIT_LOG_LEVEL)
+
+        if CLIENT_PROG_NAME:
+
+            prog_logger = Logger(
+                CLIENT_PROG_NAME,
+                LOG_DEVICE.console_level,
+                LOG_DEVICE.file_level,
+                file_name=DEFAULT_LOG_FILE_PATH.name,
+                file_path=DEFAULT_LOG_FILE_PATH.parent
+            )
+            __all__.append('PROG_LOGGER')
+
+        LOG_DEVICE.replay_and_setup_handlers()
+    elif CLIENT_PROG_NAME:
+        prog_logger = Null()
+
+    with contextlib.suppress(NameError):
+        global PROG_LOGGER
+
+        PROG_LOGGER = prog_logger
+
+        if isinstance(PROG_LOGGER, Null):
+            from rich import print
+            print("The logger has been blocked from starting. To start the logger, run `start_logger()`.")
+        
+
+InspyLogger = Logger
+
+
+def _get_loggable():
+    from inspy_logger.helpers.base_classes import Loggable
+    import bisect
+    # Add the `Loggable` class to `__all__` in alphabetical order.
+    bisect.insort(__all__, 'Loggable')
+
+    return Loggable
+
+
+Loggable = _get_loggable()
+
+
+start_logger(override_block=False)
+
+
+deprecation_warning_deliveries = 0
+
+
+def getLogger(*args, **kwargs):
+    global deprecation_warning_deliveries
+
+    if deprecation_warning_deliveries < 5:
+        LOG_DEVICE.warning('The `getLogger` function is deprecated. Use `InspyLogger` instead.')
+        deprecation_warning_deliveries += 1
+
+    return InspyLogger(*args, **kwargs)

{inspy_logger-3.1.0.dev2 → inspy_logger-3.1.0.dev4}/inspy_logger/common/__init__.py

@@ -70,7 +70,7 @@ LEVELS = list(LEVEL_MAP.values())
 """The list of level names."""
 
 
-DEFAULT_LOGGING_LEVEL = logging.DEBUG
+DEFAULT_LOGGING_LEVEL = logging.INFO
 """The default logging level."""