colored-custom-logger


Namecolored-custom-logger JSON
Version 1.6.0 PyPI version JSON
download
home_pageNone
SummaryA custom logger with colorful output
upload_time2024-09-09 01:39:46
maintainerNone
docs_urlNone
authorNone
requires_python>=3.7
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 🌈 Colored Custom Logger

[![PyPI version](https://badge.fury.io/py/colored-custom-logger.svg)](https://badge.fury.io/py/colored-custom-logger)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Python Versions](https://img.shields.io/pypi/pyversions/colored-custom-logger.svg)](https://pypi.org/project/colored-custom-logger/)

Turn your monochrome console into a vibrant logging fiesta! 🎉

## 🌟 Features

- 🎨 Colorful date and log level outputs
- 🚦 Easy-to-distinguish log levels
- 🔧 Customizable and extendable
- 🚀 Simple to integrate into existing projects
- 🐍 Pure Python, no extra dependencies (except colorama for Windows support)

## 📸 See It in Action

Feast your eyes on these beautiful logs:

![Colored Logger Demo](docs/images/showcase_example.png)

## 🚀 Installation

Get started with a simple pip install:

```bash
pip install colored-custom-logger
```

## 🎮 Quick Start

Here's a taste of what you can do with Colored Custom Logger:

```python
from colored_custom_logger import CustomLogger

# Create your fabulous logger
logger = CustomLogger.get_logger(__name__)

# Let the colorful logging begin!
logger.debug("🔍 This is a debug message")
logger.info("ℹ️ Here's some info for you")
logger.warning("⚠️ Uh-oh, this is a warning")
logger.error("❌ Oops! We've got an error")
logger.critical("🚨 MAYDAY! MAYDAY! This is critical!")

```

And voilà! Your console will transform into this:

![Logger Output](docs/images/quickstart.png)

## Documentation

Comprehensive documentation for Colored Custom Logger is available online:

- **User Guide and API Reference**: [https://robin-collins.github.io/colored_custom_logger/](https://robin-collins.github.io/colored_custom_logger/)

This documentation includes:
- Installation instructions
- Usage examples
- API reference
- Troubleshooting guide

For developers interested in contributing to the project or setting up the documentation locally:

- **Documentation Setup Guide**: See [DOCUMENTATION_SETUP.md](DOCUMENTATION_SETUP.md) in the project repository.

The documentation is built using MkDocs and hosted on GitHub Pages. It is automatically updated when changes are pushed to the main branch of the repository.

## 🌈 Color Scheme

Our carefully curated color palette ensures your logs are both beautiful and readable:

- 🔵 DEBUG: Cool Blue
- 🟢 INFO: Go Green
- 🟡 WARNING: Yummy Yellow
- 🔴 ERROR: Radical Red
- 🔥 CRITICAL: Blazing Bright Red

## 🛠️ Advanced Usage

Want to customize your logger further? No problem! Check out our advanced usage guide:

![Advanced Usage](docs/images/advanced_usage.png)

## 🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

## 📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

## 🏷️ Version

The current version of 🌈 colored-custom-logger is 1.5.7.

## 🙏 Acknowledgements

- Thanks to the [colorama](https://pypi.org/project/colorama/) project for making cross-platform colored terminal text output possible.
- Inspired by all the monochrome loggers out there, waiting for a splash of color.

---

Made with ❤️ and 🌈 by [Robin Collins](https://github.com/robin-collins)

Remember, life's too short for boring logs! 🎭🎨
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "colored-custom-logger",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Robin Collins <robin@blackcat-it.com.au>",
    "download_url": "https://files.pythonhosted.org/packages/e3/58/012526b582dcce43ba20ba81ab9808561228f93a4dcd7f4ca3c90eda9237/colored_custom_logger-1.6.0.tar.gz",
    "platform": null,
    "description": "# \ud83c\udf08 Colored Custom Logger\n\n[![PyPI version](https://badge.fury.io/py/colored-custom-logger.svg)](https://badge.fury.io/py/colored-custom-logger)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Python Versions](https://img.shields.io/pypi/pyversions/colored-custom-logger.svg)](https://pypi.org/project/colored-custom-logger/)\n\nTurn your monochrome console into a vibrant logging fiesta! \ud83c\udf89\n\n## \ud83c\udf1f Features\n\n- \ud83c\udfa8 Colorful date and log level outputs\n- \ud83d\udea6 Easy-to-distinguish log levels\n- \ud83d\udd27 Customizable and extendable\n- \ud83d\ude80 Simple to integrate into existing projects\n- \ud83d\udc0d Pure Python, no extra dependencies (except colorama for Windows support)\n\n## \ud83d\udcf8 See It in Action\n\nFeast your eyes on these beautiful logs:\n\n![Colored Logger Demo](docs/images/showcase_example.png)\n\n## \ud83d\ude80 Installation\n\nGet started with a simple pip install:\n\n```bash\npip install colored-custom-logger\n```\n\n## \ud83c\udfae Quick Start\n\nHere's a taste of what you can do with Colored Custom Logger:\n\n```python\nfrom colored_custom_logger import CustomLogger\n\n# Create your fabulous logger\nlogger = CustomLogger.get_logger(__name__)\n\n# Let the colorful logging begin!\nlogger.debug(\"\ud83d\udd0d This is a debug message\")\nlogger.info(\"\u2139\ufe0f Here's some info for you\")\nlogger.warning(\"\u26a0\ufe0f Uh-oh, this is a warning\")\nlogger.error(\"\u274c Oops! We've got an error\")\nlogger.critical(\"\ud83d\udea8 MAYDAY! MAYDAY! This is critical!\")\n\n```\n\nAnd voil\u00e0! Your console will transform into this:\n\n![Logger Output](docs/images/quickstart.png)\n\n## Documentation\n\nComprehensive documentation for Colored Custom Logger is available online:\n\n- **User Guide and API Reference**: [https://robin-collins.github.io/colored_custom_logger/](https://robin-collins.github.io/colored_custom_logger/)\n\nThis documentation includes:\n- Installation instructions\n- Usage examples\n- API reference\n- Troubleshooting guide\n\nFor developers interested in contributing to the project or setting up the documentation locally:\n\n- **Documentation Setup Guide**: See [DOCUMENTATION_SETUP.md](DOCUMENTATION_SETUP.md) in the project repository.\n\nThe documentation is built using MkDocs and hosted on GitHub Pages. It is automatically updated when changes are pushed to the main branch of the repository.\n\n## \ud83c\udf08 Color Scheme\n\nOur carefully curated color palette ensures your logs are both beautiful and readable:\n\n- \ud83d\udd35 DEBUG: Cool Blue\n- \ud83d\udfe2 INFO: Go Green\n- \ud83d\udfe1 WARNING: Yummy Yellow\n- \ud83d\udd34 ERROR: Radical Red\n- \ud83d\udd25 CRITICAL: Blazing Bright Red\n\n## \ud83d\udee0\ufe0f Advanced Usage\n\nWant to customize your logger further? No problem! Check out our advanced usage guide:\n\n![Advanced Usage](docs/images/advanced_usage.png)\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## \ud83d\udcdc License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## \ud83c\udff7\ufe0f Version\n\nThe current version of \ud83c\udf08 colored-custom-logger is 1.5.7.\n\n## \ud83d\ude4f Acknowledgements\n\n- Thanks to the [colorama](https://pypi.org/project/colorama/) project for making cross-platform colored terminal text output possible.\n- Inspired by all the monochrome loggers out there, waiting for a splash of color.\n\n---\n\nMade with \u2764\ufe0f and \ud83c\udf08 by [Robin Collins](https://github.com/robin-collins)\n\nRemember, life's too short for boring logs! \ud83c\udfad\ud83c\udfa8",
    "bugtrack_url": null,
    "license": null,
    "summary": "A custom logger with colorful output",
    "version": "1.6.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/robin-collins/colored_custom_logger/issues",
        "Documentation": "https://robin-collins.github.io/colored_custom_logger/",
        "Homepage": "https://github.com/robin-collins/colored_custom_logger"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a11738a47a0ce910a339868e8f2f0b022c9a09ef38e6a63877128f100d625b53",
                "md5": "dfd6f4cd985368cb1966764689dc141b",
                "sha256": "a70faef9bcc2f568d289e592f39148d19e978fcaacb5d0eda8480834a8e1dea5"
            },
            "downloads": -1,
            "filename": "colored_custom_logger-1.6.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "dfd6f4cd985368cb1966764689dc141b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 9152,
            "upload_time": "2024-09-09T01:39:34",
            "upload_time_iso_8601": "2024-09-09T01:39:34.365444Z",
            "url": "https://files.pythonhosted.org/packages/a1/17/38a47a0ce910a339868e8f2f0b022c9a09ef38e6a63877128f100d625b53/colored_custom_logger-1.6.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e358012526b582dcce43ba20ba81ab9808561228f93a4dcd7f4ca3c90eda9237",
                "md5": "8e423b41af6f77b0014a38892fea8873",
                "sha256": "fc3a9f7211500d5d3f199327ba125e2ea47b203ea2f5938798a4f99a1470c23a"
            },
            "downloads": -1,
            "filename": "colored_custom_logger-1.6.0.tar.gz",
            "has_sig": false,
            "md5_digest": "8e423b41af6f77b0014a38892fea8873",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 2639657,
            "upload_time": "2024-09-09T01:39:46",
            "upload_time_iso_8601": "2024-09-09T01:39:46.948674Z",
            "url": "https://files.pythonhosted.org/packages/e3/58/012526b582dcce43ba20ba81ab9808561228f93a4dcd7f4ca3c90eda9237/colored_custom_logger-1.6.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-09 01:39:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "robin-collins",
    "github_project": "colored_custom_logger",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "colored-custom-logger"
}
        
Elapsed time: 0.60439s