# 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
Raw data
{
"_id": null,
"home_page": "https://github.com/Inspyre-Softworks/inSPy-Logger",
"name": "inspy-logger",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "cli, color, logging, log, terminal, console, colorama, colorlog, rich",
"author": "Taylor-Jayde Blackstone",
"author_email": "tayjaybabee@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/43/f6/c9d448db865502a2cffac6247e312b64ab7856ccf19582bfee615aeab327/inspy_logger-3.0.3.tar.gz",
"platform": null,
"description": "# inSPy-Logger\n![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) \n![Codacy grade](https://img.shields.io/codacy/grade/7171eec682c549a88dee0da9cc9b92b3?logo=codacy&logoColor=9cf&style=for-the-badge) \n![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) \n![PyPI](https://img.shields.io/pypi/v/inspy-logger?color=9cf&label=Latest&logo=pypi&logoColor=9cf&style=for-the-badge) \n![GitHub issues](https://img.shields.io/github/issues/Inspyre-Softworks/inSPy-Logger?color=9cf&logo=github&logoColor=9cf&style=for-the-badge) \n![PyPI - Format](https://img.shields.io/pypi/format/inSPy-Logger?logo=PyPi&style=for-the-badge)\n\n## Installation\n\n### Prerequisites:\n\n**Platform/Env**:\n * **Python**: ^3.6.3\n * **PIP**: (_If you want to install via PIP, that is_)\n \n**inSPy-Logger Runtime Dependencies**:\n 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+\n \n * [colorlog](https://pypi.org/project/colorlog) (^4.2.1)\n * [setuptools-autover](https://pypi.org/project/setuptools-autover) = (^1.0.2)\n * [luddite](https://pypi.org/project/luddite) = (^1.0.1)\n * [packaging](https://pypi.org/project/packaging) = (^20.4)\n\n### Installation via Pip on Python 3.6.3+ (recommended method):\n\n- `$> python3 -m pip install inspy_logger==<version>`\n\n#### Test out InspyLogger:\n\n```python3\n\nimport inspy_logger\n\n# Set up a log device object. The first parameter is the root loggers name, and the second is the debug level\nlog_device = inspy_logger.InspyLogger('LogName', 'debug')\n\n# Start a running log from that device\nlog = log_device.start()\n\n# Output our own logger lines:\nlog.debug('This is a debug log entry')\nlog.info('This is an info log entry')\nlog.warning('This is a warning log entry!')\nlog.error('This is an error log entry!')\nlog.exception('This is an exception log entry!')\n\n```\n\nIf you run the code above you'll get output similar to this:\n\n![output1](https://github.com/Inspyre-Softworks/inSPy-Logger/blob/v2.0-alpha.6/examples/v2.0/output_screenies/v2.0.0a.6_screenie1.png)\n\nv2.0+ repository for inSPy-Logger\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Colorable, scalable logger for CLI",
"version": "3.0.3",
"project_urls": {
"Documentation": "https://inspy-logger.readthedocs.io/en/latest/",
"Homepage": "https://github.com/Inspyre-Softworks/inSPy-Logger",
"Repository": "https://github.com/Inspyre-Softworks/inSPy-Logger"
},
"split_keywords": [
"cli",
" color",
" logging",
" log",
" terminal",
" console",
" colorama",
" colorlog",
" rich"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0063448468cf881b3b79657507f6763d712d9d94b6490d77fac4dbbdef276458",
"md5": "fc4c391a349efae715711b69516086a0",
"sha256": "3c2b37a175ad5e137cf9b3751bd2f071afb6e3c8e5d915380df1db825a7661a1"
},
"downloads": -1,
"filename": "inspy_logger-3.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc4c391a349efae715711b69516086a0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 29886,
"upload_time": "2024-03-25T07:45:40",
"upload_time_iso_8601": "2024-03-25T07:45:40.329431Z",
"url": "https://files.pythonhosted.org/packages/00/63/448468cf881b3b79657507f6763d712d9d94b6490d77fac4dbbdef276458/inspy_logger-3.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "43f6c9d448db865502a2cffac6247e312b64ab7856ccf19582bfee615aeab327",
"md5": "47a751dd779413bc19fcd18d4b03a20f",
"sha256": "a77e1b28bc7e9ba20a6e89750f3830eba1e9881461a022331fdb7ccd4a5f01d8"
},
"downloads": -1,
"filename": "inspy_logger-3.0.3.tar.gz",
"has_sig": false,
"md5_digest": "47a751dd779413bc19fcd18d4b03a20f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 22913,
"upload_time": "2024-03-25T07:45:42",
"upload_time_iso_8601": "2024-03-25T07:45:42.179580Z",
"url": "https://files.pythonhosted.org/packages/43/f6/c9d448db865502a2cffac6247e312b64ab7856ccf19582bfee615aeab327/inspy_logger-3.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-25 07:45:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Inspyre-Softworks",
"github_project": "inSPy-Logger",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "inspy-logger"
}