boLogger


NameboLogger JSON
Version 0.1.3.1 PyPI version JSON
download
home_pagehttps://github.com/Bernso/boLogger
SummaryAn advanced logging system used for clear understanding of your logs.
upload_time2024-12-19 12:31:28
maintainerNone
docs_urlNone
authorBernso
requires_python<4.0,>=3.8
licenseMIT
keywords logger clear colourfull
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # What is this package?

This package is an advanced logging system that allows the user to create custom and preset logs, with colour.

# Installation

```bash
pip install boLogger --upgrade
```

# Features

- Colour
- Create your own custom logger
- Text wrapping (the text will never be on the same level as the logger info)
- Easy use

# Options

### Colours

Black, Red, Green, Yellow, Blue, Purple, Cyan, White, BBlack, BRed, BGreen, BYellow, BBlue, BPurple, BCyan, BWhite
(B stands for bright)

### Options for Logging()

```py
.header(text)
.info(text)
.warning(text)
.error(text)
.success(text)
```

### Options for CustomLog()

CustomLog() includes everything in the Logging() class and more
```py
.set_deafult(
    title: str, 
    color: str, 
    bold: bool, 
    underlined: bool
) # This is used to create deafults for the custom_log() method
  # Meaning if the user wants to use the cutom_log() method 
  # They only need to use the text parameter 

.custom_log(
    text: str,  
    title: str, 
    color: str, 
    bold: bool, 
    underlined: bool
) # If you already have a deafult set you will only need to enter the text param
  # But if you have not, you will need to enter all params
        
# Method to view the current deafult settings
# It returns it, not printing
.view_deafult() 

.add_color(colour) # your own colour code (must start with '\033[')
```

# Example Usage

```py
### Logging()
print(Logging()) # Explains the module

.header("Header")

.info("Info")

.warning("Warning")

.error("Error")

.success("Success")

.beans("Beans")

.info("This is a very long log message that is going to spill over to the next line and needs to be properly indented for better readability.")



### CustomLog()
# Explains the module
print(CustomLog()) 

# Bold and underlined are automatically set to false
.set_default(title="beansareyummy", color='Blue') 

.view_deafult()

.custom_log("custom")

.info("custom")
```





            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Bernso/boLogger",
    "name": "boLogger",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.8",
    "maintainer_email": null,
    "keywords": "Logger, Clear, Colourfull",
    "author": "Bernso",
    "author_email": "Bernso@duck.com",
    "download_url": "https://files.pythonhosted.org/packages/06/84/7830b686b280dc8b929da5e64c3fb2173bbd4e9f55e9dce38616aaf3b47f/bologger-0.1.3.1.tar.gz",
    "platform": null,
    "description": "# What is this package?\n\nThis package is an advanced logging system that allows the user to create custom and preset logs, with colour.\n\n# Installation\n\n```bash\npip install boLogger --upgrade\n```\n\n# Features\n\n- Colour\n- Create your own custom logger\n- Text wrapping (the text will never be on the same level as the logger info)\n- Easy use\n\n# Options\n\n### Colours\n\nBlack, Red, Green, Yellow, Blue, Purple, Cyan, White, BBlack, BRed, BGreen, BYellow, BBlue, BPurple, BCyan, BWhite\n(B stands for bright)\n\n### Options for Logging()\n\n```py\n.header(text)\n.info(text)\n.warning(text)\n.error(text)\n.success(text)\n```\n\n### Options for CustomLog()\n\nCustomLog() includes everything in the Logging() class and more\n```py\n.set_deafult(\n    title: str, \n    color: str, \n    bold: bool, \n    underlined: bool\n) # This is used to create deafults for the custom_log() method\n  # Meaning if the user wants to use the cutom_log() method \n  # They only need to use the text parameter \n\n.custom_log(\n    text: str,  \n    title: str, \n    color: str, \n    bold: bool, \n    underlined: bool\n) # If you already have a deafult set you will only need to enter the text param\n  # But if you have not, you will need to enter all params\n        \n# Method to view the current deafult settings\n# It returns it, not printing\n.view_deafult() \n\n.add_color(colour) # your own colour code (must start with '\\033[')\n```\n\n# Example Usage\n\n```py\n### Logging()\nprint(Logging()) # Explains the module\n\n.header(\"Header\")\n\n.info(\"Info\")\n\n.warning(\"Warning\")\n\n.error(\"Error\")\n\n.success(\"Success\")\n\n.beans(\"Beans\")\n\n.info(\"This is a very long log message that is going to spill over to the next line and needs to be properly indented for better readability.\")\n\n\n\n### CustomLog()\n# Explains the module\nprint(CustomLog()) \n\n# Bold and underlined are automatically set to false\n.set_default(title=\"beansareyummy\", color='Blue') \n\n.view_deafult()\n\n.custom_log(\"custom\")\n\n.info(\"custom\")\n```\n\n\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An advanced logging system used for clear understanding of your logs.",
    "version": "0.1.3.1",
    "project_urls": {
        "Homepage": "https://github.com/Bernso/boLogger",
        "Repository": "https://github.com/Bernso/boLogger"
    },
    "split_keywords": [
        "logger",
        " clear",
        " colourfull"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d73f2c584aee3bc5b595e5b4990410f8bd198808bcc0eb86e6b06ac7b39c0f44",
                "md5": "47aa9d9fdae385f521982bd0534e3ffc",
                "sha256": "3f17a7b1bf0926af1fbfae908e2482054bdef784175662f65fa4e5dff01c2640"
            },
            "downloads": -1,
            "filename": "bologger-0.1.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "47aa9d9fdae385f521982bd0534e3ffc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.8",
            "size": 5837,
            "upload_time": "2024-12-19T12:31:26",
            "upload_time_iso_8601": "2024-12-19T12:31:26.065447Z",
            "url": "https://files.pythonhosted.org/packages/d7/3f/2c584aee3bc5b595e5b4990410f8bd198808bcc0eb86e6b06ac7b39c0f44/bologger-0.1.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "06847830b686b280dc8b929da5e64c3fb2173bbd4e9f55e9dce38616aaf3b47f",
                "md5": "828b31e372fe8c73c3d06bc0382c17e9",
                "sha256": "09fceb28f5538dd7c176356ea367de4cb4b3e1c78d8de7684ff8d3664be39635"
            },
            "downloads": -1,
            "filename": "bologger-0.1.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "828b31e372fe8c73c3d06bc0382c17e9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.8",
            "size": 5345,
            "upload_time": "2024-12-19T12:31:28",
            "upload_time_iso_8601": "2024-12-19T12:31:28.264462Z",
            "url": "https://files.pythonhosted.org/packages/06/84/7830b686b280dc8b929da5e64c3fb2173bbd4e9f55e9dce38616aaf3b47f/bologger-0.1.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-19 12:31:28",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Bernso",
    "github_project": "boLogger",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "bologger"
}
        
Elapsed time: 0.93631s