inspy-logger 3.0.dev1__tar.gz → 3.0.dev3__tar.gz

{inspy_logger-3.0.dev1 → inspy_logger-3.0.dev3}/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.0.dev3/PKG-INFO

@@ -0,0 +1,94 @@
+Metadata-Version: 2.1
+Name: inspy-logger
+Version: 3.0.dev3
+Summary: Colorable, scalable logger for CLI
+Home-page: https://github.com/Inspyre-Softworks/inSPy-Logger
+License: MIT
+Keywords: cli,color,logging,log,terminal,console,colorama,colorlog,rich
+Author: Taylor-Jayde Blackstone
+Author-email: tayjaybabee@gmail.com
+Requires-Python: >=3.9,<4.0
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Logging
+Classifier: Topic :: Utilities
+Requires-Dist: appdirs (>=1.4.4,<2.0.0)
+Requires-Dist: colorama (>=0.4.6,<0.5.0)
+Requires-Dist: colorlog (>=6.7,<7.0)
+Requires-Dist: humanize (>=4.4.0,<5.0.0)
+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: 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
+Description-Content-Type: text/markdown
+
+# 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.0.dev3/README.md

@@ -0,0 +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-3.0.dev3/inspy_logger/Scripts/main.py

@@ -0,0 +1,91 @@
+"""
+
+File: 
+    inspy_logger/Scripts/main.py
+
+Author: 
+    Inspyre Softworks
+    
+"""
+INSPY_LOG_LEVEL = 'info'
+
+from inspy_logger.version import parse_version, get_full_version_name, PyPiVersionInfo
+import sys
+from rich import print
+from rich.table import Table
+from argparse import ArgumentParser
+
+
+parser = ArgumentParser('inspy-logger-version', description='Displays version information for inspy-logger.')
+
+parser.add_argument('-v', '--version', action='version', version=parse_version())
+
+subparsers = parser.add_subparsers(title='subcommands', dest='subcommand')
+
+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.')
+
+parsed_args = parser.parse_args()
+
+
+if parsed_args.subcommand == 'update':
+    INCLUDE_PRE_RELEASE_FOR_UPDATE_CHECK = parsed_args.pre_release
+else:
+    INCLUDE_PRE_RELEASE_FOR_UPDATE_CHECK = False
+
+
+pypi_info = PyPiVersionInfo(include_pre_release_for_update_check=INCLUDE_PRE_RELEASE_FOR_UPDATE_CHECK)
+
+
+def update():
+    """
+    Checks for updates to inspy-logger.
+
+    Returns:
+        None
+
+    Since:
+        v3.0
+    """
+    if pypi_info.update_available:
+        print(f'\n\n[bold green]Update Available![/bold green] New version: [bold cyan]{pypi_info.new_version_available}[/bold cyan]')
+    else:
+        print(f'\n\n[bold green]No update available.[/bold green] Current version: [bold cyan]{parse_version()}[/bold cyan] {"which is newer than the available version on PyPi.org" if pypi_info.installed_newer_than_latest else ""}')
+
+
+def get_version_info():
+    # Create a table
+    table = Table(show_header=False, show_lines=True, expand=True, border_style='bright_blue',
+                  row_styles=['none', 'dim'])
+
+    # Add columns
+    table.add_column('Property', style='cyan', width=20)
+    table.add_column('Value', justify='center')
+
+    # Add rows
+    table.add_row('Version', parse_version(), )
+    table.add_row('Full Version Name', get_full_version_name())
+
+    if pypi_info.update_available:
+        table.add_row('Update Available', f'[bold green]Yes[/bold green]')
+        table.add_row('Latest Version', f'{pypi_info.new_version_available_num}')
+
+    table.add_row('Python Executable Path', sys.executable)
+    table.add_row('Python Version', sys.version)
+
+    print(table)
+
+
+
+def main():
+
+    if parsed_args.subcommand == 'update':
+        return update()
+
+    return get_version_info()
+
+
+
+if __name__ == '__main__':
+    main()

{inspy_logger-3.0.dev1 → inspy_logger-3.0.dev3}/inspy_logger/__about__.py

@@ -1,33 +1,33 @@
-"""
-
-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
-
-"""
-
-__prog__ = 'inSPy-Logger'
-__version__ = '3.0-dev.1'
-__authors__ = [
-        ('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)
-
-'''
+"""
+
+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
+
+"""
+
+__prog__ = 'inSPy-Logger'
+__version__ = '3.0-dev.1'
+__authors__ = [
+        ('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)
+
+'''