| Name | EpiLog JSON |
| Version |
1.1.2
JSON |
| download |
| home_page | None |
| Summary | Simple No-Frills Logging Manager |
| upload_time | 2024-12-06 21:32:56 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2023 Spill-Tea Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
logging
benchmark
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<!-- omit in toc -->
# EpiLog
Simple Logging Manager
<!-- omit in toc -->
## Table of Contents
- [Installation](#installation)
- [Examples](#examples)
- [License](#license)
# Installation
Install from [pypi](https://pypi.org/project/EpiLog/) using pip.
```bash
pip install EpiLog
```
or directly from github, if you want the latest dev
```bash
pip install git+https://github.com/Spill-Tea/EpiLog@main
```
# Examples
Creating a logging manager and dispatch a logger.
```python
import logging
from EpiLog import EpiLog
formatter = logging.Formatter("%(asctime)s | %(levelname)s | %(message)s")
manager: EpiLog = EpiLog(logging.DEBUG, formatter=formatter)
log: logging.Logger = manager.get_logger(__name__)
log.debug("We made a logger!")
# And easily remove the logger
manager.remove(log)
assert __name__ not in manager
```
Benchmarking real time duration to accomplish a function,
or a series of tasks within a facile context manager.
```python
import logging
from EpiLog import Benchmark
message: str = "Long Task Complete"
level: int = logging.INFO # level to emit message
with Benchmark(log, message, level):
perform_long_task(...)
```
Note, that if the level used to emit the message is below
your logger level, then no message will be emitted.
# License
[MIT](LICENSE)
Raw data
{
"_id": null,
"home_page": null,
"name": "EpiLog",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Jason C Del Rio <spillthetea917@gmail.com>",
"keywords": "logging, benchmark",
"author": null,
"author_email": "Jason C Del Rio <spillthetea917@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/af/c6/b5bce8ab701a6944f1c65880dcf2d516d418d7da1e4790cb459bdd08a9be/epilog-1.1.2.tar.gz",
"platform": null,
"description": "<!-- omit in toc -->\n# EpiLog\nSimple Logging Manager\n\n<!-- omit in toc -->\n## Table of Contents\n- [Installation](#installation)\n- [Examples](#examples)\n- [License](#license)\n\n# Installation\nInstall from [pypi](https://pypi.org/project/EpiLog/) using pip.\n\n```bash\npip install EpiLog\n```\n\nor directly from github, if you want the latest dev\n\n```bash\npip install git+https://github.com/Spill-Tea/EpiLog@main\n```\n\n# Examples\n\nCreating a logging manager and dispatch a logger.\n```python\nimport logging\nfrom EpiLog import EpiLog\n\nformatter = logging.Formatter(\"%(asctime)s | %(levelname)s | %(message)s\")\nmanager: EpiLog = EpiLog(logging.DEBUG, formatter=formatter)\nlog: logging.Logger = manager.get_logger(__name__)\nlog.debug(\"We made a logger!\")\n\n# And easily remove the logger\nmanager.remove(log)\nassert __name__ not in manager\n```\n\n\nBenchmarking real time duration to accomplish a function,\nor a series of tasks within a facile context manager.\n\n```python\nimport logging\nfrom EpiLog import Benchmark\n\nmessage: str = \"Long Task Complete\"\nlevel: int = logging.INFO # level to emit message\nwith Benchmark(log, message, level):\n perform_long_task(...)\n\n```\nNote, that if the level used to emit the message is below\nyour logger level, then no message will be emitted.\n\n# License\n\n[MIT](LICENSE)\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Spill-Tea Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Simple No-Frills Logging Manager",
"version": "1.1.2",
"project_urls": {
"homepage": "https://github.com/Spill-Tea/EpiLog",
"issues": "https://github.com/Spill-Tea/EpiLog/issues"
},
"split_keywords": [
"logging",
" benchmark"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71faedac951cbfa4a133560b52ef46080944e97f5adfad948f66eb18263b105c",
"md5": "8a96eccfdb758e2c8903d3511944c7ec",
"sha256": "00857fab1b90694a5788a3628c1247f7702b9593c19d620d302d2992d24c61ce"
},
"downloads": -1,
"filename": "EpiLog-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8a96eccfdb758e2c8903d3511944c7ec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 8933,
"upload_time": "2024-12-06T21:32:55",
"upload_time_iso_8601": "2024-12-06T21:32:55.124416Z",
"url": "https://files.pythonhosted.org/packages/71/fa/edac951cbfa4a133560b52ef46080944e97f5adfad948f66eb18263b105c/EpiLog-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "afc6b5bce8ab701a6944f1c65880dcf2d516d418d7da1e4790cb459bdd08a9be",
"md5": "5482ca5aa978579d317f8c257c5824a7",
"sha256": "974243a1a9e11b1362f30ca7cf543f38b521de08bebb876802447da40b67203e"
},
"downloads": -1,
"filename": "epilog-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "5482ca5aa978579d317f8c257c5824a7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 11040,
"upload_time": "2024-12-06T21:32:56",
"upload_time_iso_8601": "2024-12-06T21:32:56.013454Z",
"url": "https://files.pythonhosted.org/packages/af/c6/b5bce8ab701a6944f1c65880dcf2d516d418d7da1e4790cb459bdd08a9be/epilog-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 21:32:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Spill-Tea",
"github_project": "EpiLog",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "epilog"
}
