# SciLogger - Logging for Scientific Applications
> * **Repository: [github.com/otvam/scilogger](https://github.com/otvam/scilogger)**
> * **PyPi: [pypi.org/project/scilogger](https://pypi.org/project/scilogger)**
> * **Conda: [anaconda.org/conda-forge/scilogger](https://anaconda.org/conda-forge/scilogger)**
## Summary
**SciLogger** is a **Python Logging** module:
* Specially targeted for **scientific applications**.
* Use a **global timer** to measure the **elapsed time**.
* Provide a class for **timing code blocks**.
* Definition of **custom indentation levels**.
* Definition of **colors** for the logging levels.
**SciLogger** is using a global **INI configuration** file:
* First, the **default configuration** is loaded (`scilogger/scilogger.ini`).
* Afterward, a **custom file** can be loaded with an environment variable (`SCILOGGER`)
SciLogger is written in Python without any external dependencies.
SciLogger is respecting **semantic versioning** (starting from version 1.2).
## Warning
* This logging module is **based** on the **Python logging module**.
* The philosophy of this logging module is slightly different.
* Mixing both modules can create strange/incorrect behaviors.
## Example
An example is located in the `example` folder of the repository:
* `run_logger.py` contains an example file for the logger
* `configlogger.ini` contains a custom configuration file
```bash
# Set the configuration file.
export SCILOGGER="configlocal.ini"
# Run the Python script.
python run_logger.py
```
## Project Links
* Repository: https://github.com/otvam/scilogger
* Releases: https://github.com/otvam/scilogger/releases
* Tags: https://github.com/otvam/scilogger/tags
* Issues: https://github.com/otvam/scilogger/issues
* PyPi: https://pypi.org/project/scilogger
* Conda: https://anaconda.org/conda-forge/scilogger
## Author
* **Thomas Guillod**
* Email: guillod@otvam.ch
* Website: https://otvam.ch
## Copyright
> (c) 2023 - Thomas Guillod
>
> BSD 2-Clause "Simplified" License
Raw data
{
"_id": null,
"home_page": null,
"name": "scilogger",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Thomas Guillod <guillod@otvam.ch>",
"keywords": "Python, Timing, Logging, Logger, Log",
"author": null,
"author_email": "Thomas Guillod <guillod@otvam.ch>",
"download_url": "https://files.pythonhosted.org/packages/ee/4e/91631af27786152b83811c04930a94cc8e43f4672c5c26f2e3217335999f/scilogger-1.2.3.tar.gz",
"platform": null,
"description": "# SciLogger - Logging for Scientific Applications \n\n> * **Repository: [github.com/otvam/scilogger](https://github.com/otvam/scilogger)**\n> * **PyPi: [pypi.org/project/scilogger](https://pypi.org/project/scilogger)**\n> * **Conda: [anaconda.org/conda-forge/scilogger](https://anaconda.org/conda-forge/scilogger)**\n\n## Summary\n\n**SciLogger** is a **Python Logging** module:\n* Specially targeted for **scientific applications**.\n* Use a **global timer** to measure the **elapsed time**.\n* Provide a class for **timing code blocks**.\n* Definition of **custom indentation levels**.\n* Definition of **colors** for the logging levels.\n\n**SciLogger** is using a global **INI configuration** file:\n* First, the **default configuration** is loaded (`scilogger/scilogger.ini`).\n* Afterward, a **custom file** can be loaded with an environment variable (`SCILOGGER`)\n\nSciLogger is written in Python without any external dependencies.\nSciLogger is respecting **semantic versioning** (starting from version 1.2).\n\n## Warning\n\n* This logging module is **based** on the **Python logging module**.\n* The philosophy of this logging module is slightly different. \n* Mixing both modules can create strange/incorrect behaviors.\n\n## Example\n\nAn example is located in the `example` folder of the repository:\n* `run_logger.py` contains an example file for the logger\n* `configlogger.ini` contains a custom configuration file\n\n```bash\n# Set the configuration file.\nexport SCILOGGER=\"configlocal.ini\"\n\n# Run the Python script.\npython run_logger.py\n```\n\n## Project Links\n\n* Repository: https://github.com/otvam/scilogger\n* Releases: https://github.com/otvam/scilogger/releases\n* Tags: https://github.com/otvam/scilogger/tags\n* Issues: https://github.com/otvam/scilogger/issues\n* PyPi: https://pypi.org/project/scilogger\n* Conda: https://anaconda.org/conda-forge/scilogger\n\n## Author\n\n* **Thomas Guillod**\n* Email: guillod@otvam.ch\n* Website: https://otvam.ch\n\n## Copyright\n\n> (c) 2023 - Thomas Guillod\n> \n> BSD 2-Clause \"Simplified\" License\n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "SciLogger - Logging for Scientific Applications",
"version": "1.2.3",
"project_urls": {
"Homepage": "https://github.com/otvam/scilogger",
"Issues": "https://github.com/otvam/scilogger/issues",
"Releases": "https://github.com/otvam/scilogger/releases",
"Repository": "https://github.com/otvam/scilogger",
"Tags": "https://github.com/otvam/scilogger/tags"
},
"split_keywords": [
"python",
" timing",
" logging",
" logger",
" log"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9b46f3f594c1d77e965b17622317be57f286191dfe6455cf1ca24fb3f20ce660",
"md5": "c7c9cae3b395d36dccce56c496805ccd",
"sha256": "2aa1dc0e37a60123ef31dd7b66f3099b171b96b50badd5078370d6d31aaf24ff"
},
"downloads": -1,
"filename": "scilogger-1.2.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c7c9cae3b395d36dccce56c496805ccd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 9205,
"upload_time": "2024-12-19T21:40:32",
"upload_time_iso_8601": "2024-12-19T21:40:32.325852Z",
"url": "https://files.pythonhosted.org/packages/9b/46/f3f594c1d77e965b17622317be57f286191dfe6455cf1ca24fb3f20ce660/scilogger-1.2.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee4e91631af27786152b83811c04930a94cc8e43f4672c5c26f2e3217335999f",
"md5": "809bc8e0fd7d0003a420f4079d1cb716",
"sha256": "18adeb40bfc1ccf2cba882e8ee405e3a0943f4ae6b35a34602b36edb61ff1f9b"
},
"downloads": -1,
"filename": "scilogger-1.2.3.tar.gz",
"has_sig": false,
"md5_digest": "809bc8e0fd7d0003a420f4079d1cb716",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 11756,
"upload_time": "2024-12-19T21:40:34",
"upload_time_iso_8601": "2024-12-19T21:40:34.662889Z",
"url": "https://files.pythonhosted.org/packages/ee/4e/91631af27786152b83811c04930a94cc8e43f4672c5c26f2e3217335999f/scilogger-1.2.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-19 21:40:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "otvam",
"github_project": "scilogger",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "scilogger"
}
JSON
