# What is this package?
This package is an advanced logging system that allows the user to create custom and preset logs, with colour.
# <strong>Installation</strong>
```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
- BGree
- BYellow
- BBlue
- BPurple
- BCyan
- BWhite
<br>
<strong>
B stands for bright
</strong>
## Options for Logging()
```py
.header(text)
.info(text)
.warning(text)
.error(text)
.success(text)
.input(text)
.set_colour(
method, # one of the basic logging names e.g. 'info'
colour # a valid colour code or colour name
)
```
## Options for CustomLog()
CustomLog() includes everything in the Logging() class and more
```py
.set_default_custom(
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()
myLogger = Logging()
# Explains the module
print(myLogger)
myLogger.header("Header")
myLogger.info("Info")
myLogger.warning("Warning")
myLogger.error("Error")
myLogger.success("Success")
myLogger.beans("Beans")
myLogger.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.")
# Functions as a normal input but has the logging decorations
user_choice = myLogger.input("This is a re-designed input")
myLogger.info(f"The user inputted: {user_choice}")
### CustomLog()
myLogger = CustomLog()
# Explains the module
print(myLogger)
# Bold and underlined are automatically set to false
myLogger.set_default(title="beansareyummy", color='Blue')
myLogger.view_deafult()
myLogger.custom_log("custom")
myLogger.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, Inputs",
"author": "Bernso",
"author_email": "Bernso@duck.com",
"download_url": null,
"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# <strong>Installation</strong>\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\n- Black\n- Red\n- Green\n- Yellow\n- Blue\n- Purple\n- Cyan\n- White\n- BBlack\n- BRed\n- BGree\n- BYellow\n- BBlue\n- BPurple\n- BCyan\n- BWhite\n\n<br>\n<strong>\nB stands for bright\n</strong>\n\n## Options for Logging()\n\n```py\n.header(text)\n\n.info(text)\n\n.warning(text)\n\n.error(text)\n\n.success(text)\n\n.input(text)\n\n.set_colour(\n method, # one of the basic logging names e.g. 'info'\n colour # a valid colour code or colour name\n)\n```\n\n## Options for CustomLog()\n\nCustomLog() includes everything in the Logging() class and more\n\n```py\n.set_default_custom(\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()\n\nmyLogger = Logging()\n\n# Explains the module\nprint(myLogger) \n\nmyLogger.header(\"Header\")\n\nmyLogger.info(\"Info\")\n\nmyLogger.warning(\"Warning\")\n\nmyLogger.error(\"Error\")\n\nmyLogger.success(\"Success\")\n\nmyLogger.beans(\"Beans\")\n\nmyLogger.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# Functions as a normal input but has the logging decorations\nuser_choice = myLogger.input(\"This is a re-designed input\") \nmyLogger.info(f\"The user inputted: {user_choice}\")\n\n\n### CustomLog()\n\nmyLogger = CustomLog()\n\n# Explains the module\nprint(myLogger) \n\n# Bold and underlined are automatically set to false\nmyLogger.set_default(title=\"beansareyummy\", color='Blue') \n\nmyLogger.view_deafult()\n\nmyLogger.custom_log(\"custom\")\n\nmyLogger.info(\"custom\")\n```\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "An advanced logging system used for clear understanding of your logs.",
"version": "0.1.4.1",
"project_urls": {
"Homepage": "https://github.com/Bernso/boLogger",
"Repository": "https://github.com/Bernso/boLogger"
},
"split_keywords": [
"logger",
" clear",
" colourfull",
" inputs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "70e199fb2b8300cc842a4fee35087a63b8b6ad23f8ef7beed535c5daaed39175",
"md5": "f1ad11ba1588b1c1e94d6cf8deb39b96",
"sha256": "1ba6c1bfb4fda4f14e4748c78507562459f9671840475c5fa0860bd216c25c87"
},
"downloads": -1,
"filename": "bologger-0.1.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f1ad11ba1588b1c1e94d6cf8deb39b96",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 6539,
"upload_time": "2025-02-01T17:17:35",
"upload_time_iso_8601": "2025-02-01T17:17:35.449344Z",
"url": "https://files.pythonhosted.org/packages/70/e1/99fb2b8300cc842a4fee35087a63b8b6ad23f8ef7beed535c5daaed39175/bologger-0.1.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-01 17:17:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Bernso",
"github_project": "boLogger",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bologger"
}
JSON
