colorlogging

Name	colorlogging JSON
Version	0.0.2 JSON
	download
home_page	https://github.com/kscalelabs/colorlogging
Summary	A simple utility package for Python logging with colors
upload_time	2024-10-16 20:11:58
maintainer	None
docs_url	None
author	Benjamin Bolte
requires_python	>=3.11
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            <p align="center">
  <picture>
    <img alt="K-Scale Open Source Robotics" src="https://media.kscale.dev/kscale-open-source-header.png" style="max-width: 100%;">
  </picture>
</p>

<div align="center">

[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/kscalelabs/urdf2mjcf/blob/main/LICENSE)
[![Version](https://img.shields.io/pypi/v/urdf2mjcf)](https://pypi.org/project/urdf2mjcf/)
[![Discord](https://img.shields.io/discord/1224056091017478166)](https://discord.gg/kscale)
[![Wiki](https://img.shields.io/badge/wiki-humanoids-black)](https://humanoids.wiki)
<br />
[![python](https://img.shields.io/badge/-Python_3.11-blue?logo=python&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![black](https://img.shields.io/badge/Code%20Style-Black-black.svg?labelColor=gray)](https://black.readthedocs.io/en/stable/)
[![ruff](https://img.shields.io/badge/Linter-Ruff-red.svg?labelColor=gray)](https://github.com/charliermarsh/ruff)

</div>

# colorlogging

Makes logging colorful!

<p align="center">
  <img src="./docs/example.png" alt="Example of colorlogging output">
</p>

<p align="center">
  <em>Example of colorlogging output</em>
</p>

## Installation

Simply run

```bash
pip install colorlogging
```

## Usage

To configure logging, call `configure_logging` like so:

```python
import colorlogging
import logging

logger = logging.getLogger(__name__)

def main() -> None:
    colorlogging.configure()
    logger.info("Hello, world!")
```

This tool also provides some other helpful display functions:

```python
import colorlogging

colorlogging.show_info("This is a status message", important=True)
colorlogging.show_warning("This is a warning message")
colorlogging.show_error("This is an error message")
```

This shows the following output:

<p align="center">
  <img src="./docs/example2.png" alt="Another example of colorlogging output">
</p>

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kscalelabs/colorlogging",
    "name": "colorlogging",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Benjamin Bolte",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/a1/49/b11ed1d66a453a9d948a23e8e91a36c3595007e9a2cf3b259704052f23c1/colorlogging-0.0.2.tar.gz",
    "platform": null,
    "description": "<p align=\"center\">\n  <picture>\n    <img alt=\"K-Scale Open Source Robotics\" src=\"https://media.kscale.dev/kscale-open-source-header.png\" style=\"max-width: 100%;\">\n  </picture>\n</p>\n\n<div align=\"center\">\n\n[![License](https://img.shields.io/badge/license-MIT-green)](https://github.com/kscalelabs/urdf2mjcf/blob/main/LICENSE)\n[![Version](https://img.shields.io/pypi/v/urdf2mjcf)](https://pypi.org/project/urdf2mjcf/)\n[![Discord](https://img.shields.io/discord/1224056091017478166)](https://discord.gg/kscale)\n[![Wiki](https://img.shields.io/badge/wiki-humanoids-black)](https://humanoids.wiki)\n<br />\n[![python](https://img.shields.io/badge/-Python_3.11-blue?logo=python&logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![black](https://img.shields.io/badge/Code%20Style-Black-black.svg?labelColor=gray)](https://black.readthedocs.io/en/stable/)\n[![ruff](https://img.shields.io/badge/Linter-Ruff-red.svg?labelColor=gray)](https://github.com/charliermarsh/ruff)\n\n</div>\n\n# colorlogging\n\nMakes logging colorful!\n\n<p align=\"center\">\n  <img src=\"./docs/example.png\" alt=\"Example of colorlogging output\">\n</p>\n\n<p align=\"center\">\n  <em>Example of colorlogging output</em>\n</p>\n\n## Installation\n\nSimply run\n\n```bash\npip install colorlogging\n```\n\n## Usage\n\nTo configure logging, call `configure_logging` like so:\n\n```python\nimport colorlogging\nimport logging\n\nlogger = logging.getLogger(__name__)\n\ndef main() -> None:\n    colorlogging.configure()\n    logger.info(\"Hello, world!\")\n```\n\nThis tool also provides some other helpful display functions:\n\n```python\nimport colorlogging\n\ncolorlogging.show_info(\"This is a status message\", important=True)\ncolorlogging.show_warning(\"This is a warning message\")\ncolorlogging.show_error(\"This is an error message\")\n```\n\nThis shows the following output:\n\n<p align=\"center\">\n  <img src=\"./docs/example2.png\" alt=\"Another example of colorlogging output\">\n</p>\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A simple utility package for Python logging with colors",
    "version": "0.0.2",
    "project_urls": {
        "Homepage": "https://github.com/kscalelabs/colorlogging"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8788ea3a8378de7a78703d5f10bd04a4f83b193e5026a60d29bacec6c899e188",
                "md5": "893528449904777683128187a7a646f7",
                "sha256": "ae9a3ce3ceca60372569f6acbad7cfd097f812d40596b655c26a74283f9f9faf"
            },
            "downloads": -1,
            "filename": "colorlogging-0.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "893528449904777683128187a7a646f7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 6014,
            "upload_time": "2024-10-16T20:11:57",
            "upload_time_iso_8601": "2024-10-16T20:11:57.623478Z",
            "url": "https://files.pythonhosted.org/packages/87/88/ea3a8378de7a78703d5f10bd04a4f83b193e5026a60d29bacec6c899e188/colorlogging-0.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a149b11ed1d66a453a9d948a23e8e91a36c3595007e9a2cf3b259704052f23c1",
                "md5": "688431572c744e279c96233d8ada0cd8",
                "sha256": "f1d47ca553df59706474296187679655781a80c00d53202617625ada3c3cb890"
            },
            "downloads": -1,
            "filename": "colorlogging-0.0.2.tar.gz",
            "has_sig": false,
            "md5_digest": "688431572c744e279c96233d8ada0cd8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 34961,
            "upload_time": "2024-10-16T20:11:58",
            "upload_time_iso_8601": "2024-10-16T20:11:58.748017Z",
            "url": "https://files.pythonhosted.org/packages/a1/49/b11ed1d66a453a9d948a23e8e91a36c3595007e9a2cf3b259704052f23c1/colorlogging-0.0.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-16 20:11:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kscalelabs",
    "github_project": "colorlogging",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "colorlogging"
}