<div align="center">
<img src="assets/logly_logo.png" alt="Sample Image">
# Logly
[](https://github.com/muhammad-fiaz/logly/actions/workflows/python-package.yaml)
[](https://pypi.org/project/logly/)
[](https://pypi.org/project/logly/)
[](https://opensource.org/licenses/MIT)
[](https://pypi.org/project/logly/)
[](https://github.com/muhammad-fiaz/logly)
[](https://github.com/muhammad-fiaz/logly/issues)
[](https://github.com/muhammad-fiaz/logly/stargazers)
[](https://github.com/muhammad-fiaz/logly/network)
[](https://github.com/muhammad-fiaz)
[](https://github.com/sponsors/muhammad-fiaz)
[](https://opensource.org/licenses/MIT)
[](https://github.com/muhammad-fiaz/logly)
</div>
Tired of writing custom logging code for your Python applications?
Logly is a ready to go logging utility that provides an easy way to log messages with different levels, colors, and many custom options. It is designed to be flexible, allowing you to customize the log messages based on your application's needs. Logly supports logging to both the console and a file, and it comes with built-in color-coded log levels for better visibility.
if you like this project, make sure to star 🌟 it in the [repository](https://github.com/muhammad-fiaz/logly/) and if you want to contribute make sure to fork this repository❤✨.
## Table of Contents
1. [Introduction](#)
2. [Installation](#installation)
3. [Features](#features)
4. [Usage](#usage)
- [Getting Started](#getting-started)
- [Explanation](#explanation)
5. [Set Default Path](#set-default-path)
6. [Color Options](#color-options)
- [Default Color Options](#default-color-options)
- [Custom Color Options](#custom-color-options)
7. [Tips & Tricks](#tips--tricks)
8. [Contributing](#contributing)
9. [Code of Conduct](#code-of-conduct)
10. [License](#license)
11. [Support the Project](#support-the-project)
12. [Happy Coding](#happy-coding)
## Features
- Easy-to-use logging for Python applications.
- Customizable log levels and formatting.
- Customizable log colors.
- Log to file and/or console.
- Log to file with automatic file rotation.
- Log to file with automatic file size management.
- Log to file with automatic file deletion.
- Log to file with automatic deletion and rewriting of the file when it reaches max_file_size.
- Open Source: Logly is an open-source project, and we welcome contributions from the community.
- Community Support: Join a community of developers using Logly for their logging needs.
- many more features!
## Getting Started
## Installation
```bash
pip install logly
```
## Usage
```python
# Import Logly
from logly import Logly
# Create a Logly instance
logly = Logly()
# logly = Logly(show_time=False) # Include timestamps in log messages default is true, and you can set it to false will not show the time in all log messages
# Start logging will store the log in text file
logly.start_logging() #make sure to include this or else the log will only display without storing it
logly.info("hello this is log")
logly.info("hello this is log", color=logly.COLOR.RED) # with custom color
# Log messages with different levels and colors
logly.info("Key1", "Value1", color=logly.COLOR.CYAN)
logly.warn("Key2", "Value2", color=logly.COLOR.YELLOW)
logly.error("Key3", "Value3", color=logly.COLOR.RED)
logly.debug("Key4", "Value4", color=logly.COLOR.BLUE)
logly.critical("Key5", "Value5", color=logly.COLOR.CRITICAL)
logly.fatal("Key6", "Value6", color=logly.COLOR.CRITICAL)
logly.trace("Key7", "Value7", color=logly.COLOR.BLUE)
logly.log("Key8", "Value8", color=logly.COLOR.WHITE)
# Stop logging (messages will be displayed but not logged in file after this point)
logly.stop_logging()
# Log more messages after stopping logging (messages will be displayed but not logged in file after this point)
logly.info("AnotherKey1", "AnotherValue1", color=logly.COLOR.CYAN)
logly.warn("AnotherKey2", "AnotherValue2", color=logly.COLOR.YELLOW)
logly.error("AnotherKey3", "AnotherValue3", color=logly.COLOR.RED)
logly.info("hello this is log", color=logly.COLOR.RED,show_time=False) # with custom color and without time
# Start logging again
logly.start_logging()
# Set the default file path and max file size
logly.set_default_file_path("log.txt") # Set the default file path is "log.txt" if you want to set the file path where you want to save the log file.
logly.set_default_max_file_size(50) # set default max file size is 50 MB
# Log messages with default settings (using default file path and max file size)
logly.info("DefaultKey1", "DefaultValue1")
logly.warn("DefaultKey2", "DefaultValue2")
logly.error("DefaultKey3", "DefaultValue3", log_to_file=False)
#The DEFAULT FILE SIZE IS 100 MB in the txt file
# Log messages with custom file path and max file size(optional)
logly.info("CustomKey1", "CustomValue1", file_path="path/c.txt", max_file_size=25) # max_file_size is in MB and create a new file when the file size reaches max_file_size
logly.warn("CustomKey2", "CustomValue2", file_path="path/c.txt", max_file_size=25,auto=True) # auto=True will automatically delete the file data when it reaches max_file_size
# Access color constants directly
logly.info("Accessing color directly", "DirectColorValue", color=logly.COLOR.RED)
# Disable color
logly.color_enabled = False
logly.info("ColorDisabledKey", "ColorDisabledValue", color=logly.COLOR.RED)
logly.info("ColorDisabledKey1", "ColorDisabledValue1", color=logly.COLOR.RED,color_enabled=True) # This will enable the color for this one log message
logly.color_enabled = True
# this will enable the color again
logly.info("ColorDisabledKey1", "ColorDisabledValue1", color=logly.COLOR.RED,color_enabled=False) # this will disable the color for this one log message
# Display logged messages (this will display all the messages logged so far)
print("Logged Messages:")
for message in logly.logged_messages:
print(message)
```
## Explanation:
1. Import the `Logly` class from the `logly` module.
2. Create an instance of `Logly`.
3. Start logging using the `start_logging()` method.
4. Log messages with various levels (info, warn, error, debug, critical, fatal, trace) and colors.
5. Stop logging using the `stop_logging()` method.
6. Log additional messages after stopping logging.
7. Start logging again.
8. Log messages with default settings, custom file path, and max file size.
9. Access color constants directly.
10. Display logged messages.
11. enable/disable timestamp support
12. enable/disable color for log support
for more information, check the [repository](https://github.com/muhammad-fiaz/logly)
## Set the Default Path
If you encounter an error related to the default file path, you can use the following code snippet to set the default path:
```python3
import os
from logly import Logly
logly = Logly()
logly.start_logging()
# Set the default file path and maximum file size
logly.set_default_max_file_size(50)
logger = os.path.join(os.path.dirname(os.path.abspath(__file__)), "log.txt")
logly.set_default_file_path(logger)
```
This will set the default file path, and you can customize it according to your requirements.
if you want to set the default path for the log file, you can use the following code snippet
```python3
from logly import Logly
logly = Logly()
logly.set_default_file_path("log.txt")
```
if you faced an error like [`FileNotFoundError: [Errno 2] No such file or directory: 'log.txt'`](https://github.com/muhammad-fiaz/logly/issues/4) you can use the following code snippet to set the default path
```python3
import os
from logly import Logly
logly = Logly() # initialize the logly
logly.start_logging() # make sure to include this or else the log will only display without storing it
logly.set_default_max_file_size(50) # optional
logger = os.path.join(os.path.dirname(os.path.abspath(__file__)), "log.txt") # This will ensure the path location to create the log.txt on current directory
logly.set_default_file_path(logger)
```
for more information, check the [repository](https://github.com/muhammad-fiaz/logly).
## Color Options:
### Default Color Options:
| Level | Color Code |
| -------- | --------------- |
| INFO | CYAN |
| WARNING | YELLOW |
| ERROR | RED |
| DEBUG | BLUE |
| CRITICAL | BRIGHT RED |
| TRACE | BLUE |
| DEFAULT | WHITE |
### Custom Color Options:
You can use any of the following color codes for custom coloring:
| NAME | Color Code |
|----------| --------------- |
| CYAN | CYAN |
| YELLOW | YELLOW |
| RED | RED |
| BLUE | BLUE |
| BRIGHT RED | CRITICAL |
|WHITE | WHITE |
For example, you can use `color=logly.COLOR.RED` for the red color.
## Tips & Tricks
If you want to use logly in your project files without creating a new object in each Python file or class, you can create a file named logly.py. In this file, initialize logly and configure the defaults. Now, you can easily import and use it throughout your project:
`logly.py`
```python3
# logly.py in your root or custom path
# Import Logly
from logly import Logly
import os
logly = Logly()
logly.start_logging()
# Set the default file path and maximum file size
logly.set_default_max_file_size(50)
logger = os.path.join(os.path.dirname(os.path.abspath(__file__)), "log.txt") # This will ensure the path location to create the log.txt
logly.set_default_file_path(logger)
# Start logging again
logly.start_logging()
```
you can now use the logly by
`main.py`
```python3
from logly import logly # make sure to import it some IDE may automatically import it on top
logly.info("msg","hello this is logly", color=logly.COLOR.RED) # with custom color of red
```
### output
```
[XXXX-XX-XX XX:XX: XX] INFo: msg: hello this is logly
```
## Contributing
Contributions are welcome! Before contributing, please read our [Contributing Guidelines](CONTRIBUTING.md) to ensure a smooth and collaborative development process.
## Code of Conduct
Please review our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the standards of behavior we expect from contributors and users of this project.
## License
This project is licensed under the [MIT License](). See [LICENSE](LICENSE) for more details.
## Support the Project
<br>
<div align="center">
_Support the Project by Becoming a Sponsor on GitHub_
[](https://github.com/sponsors/muhammad-fiaz)
</div>
## Happy Coding
Raw data
{
"_id": null,
"home_page": "https://github.com/muhammad-fiaz/logly.git",
"name": "logly",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "log, logging, logly, python",
"author": "Muhammad Fiaz",
"author_email": "contact@muhammmadfiaz.com",
"download_url": "https://files.pythonhosted.org/packages/8d/c5/24e0772530a2bc8eecb8f306d9c68680599d829ccac65eeb8b0892793680/logly-0.0.6.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n\n<img src=\"assets/logly_logo.png\" alt=\"Sample Image\">\n\n\n# Logly\n\n[](https://github.com/muhammad-fiaz/logly/actions/workflows/python-package.yaml)\n[](https://pypi.org/project/logly/)\n[](https://pypi.org/project/logly/)\n[](https://opensource.org/licenses/MIT)\n[](https://pypi.org/project/logly/)\n[](https://github.com/muhammad-fiaz/logly)\n[](https://github.com/muhammad-fiaz/logly/issues)\n[](https://github.com/muhammad-fiaz/logly/stargazers)\n[](https://github.com/muhammad-fiaz/logly/network)\n\n[](https://github.com/muhammad-fiaz)\n[](https://github.com/sponsors/muhammad-fiaz)\n[](https://opensource.org/licenses/MIT)\n[](https://github.com/muhammad-fiaz/logly)\n\n</div>\n\nTired of writing custom logging code for your Python applications? \n\nLogly is a ready to go logging utility that provides an easy way to log messages with different levels, colors, and many custom options. It is designed to be flexible, allowing you to customize the log messages based on your application's needs. Logly supports logging to both the console and a file, and it comes with built-in color-coded log levels for better visibility.\n\nif you like this project, make sure to star \ud83c\udf1f it in the [repository](https://github.com/muhammad-fiaz/logly/) and if you want to contribute make sure to fork this repository\u2764\u2728.\n\n## Table of Contents\n\n1. [Introduction](#)\n2. [Installation](#installation)\n3. [Features](#features)\n4. [Usage](#usage)\n - [Getting Started](#getting-started)\n - [Explanation](#explanation)\n5. [Set Default Path](#set-default-path)\n6. [Color Options](#color-options)\n - [Default Color Options](#default-color-options)\n - [Custom Color Options](#custom-color-options)\n7. [Tips & Tricks](#tips--tricks)\n8. [Contributing](#contributing)\n9. [Code of Conduct](#code-of-conduct)\n10. [License](#license)\n11. [Support the Project](#support-the-project)\n12. [Happy Coding](#happy-coding)\n\n\n## Features\n\n- Easy-to-use logging for Python applications.\n- Customizable log levels and formatting.\n- Customizable log colors.\n- Log to file and/or console.\n- Log to file with automatic file rotation.\n- Log to file with automatic file size management.\n- Log to file with automatic file deletion.\n- Log to file with automatic deletion and rewriting of the file when it reaches max_file_size. \n- Open Source: Logly is an open-source project, and we welcome contributions from the community.\n- Community Support: Join a community of developers using Logly for their logging needs.\n- many more features!\n\n## Getting Started\n\n## Installation\n\n```bash\npip install logly\n```\n\n## Usage\n\n```python\n# Import Logly\nfrom logly import Logly\n\n# Create a Logly instance\nlogly = Logly()\n# logly = Logly(show_time=False) # Include timestamps in log messages default is true, and you can set it to false will not show the time in all log messages\n\n# Start logging will store the log in text file\nlogly.start_logging() #make sure to include this or else the log will only display without storing it\n\nlogly.info(\"hello this is log\")\nlogly.info(\"hello this is log\", color=logly.COLOR.RED) # with custom color\n\n# Log messages with different levels and colors\nlogly.info(\"Key1\", \"Value1\", color=logly.COLOR.CYAN)\nlogly.warn(\"Key2\", \"Value2\", color=logly.COLOR.YELLOW)\nlogly.error(\"Key3\", \"Value3\", color=logly.COLOR.RED)\nlogly.debug(\"Key4\", \"Value4\", color=logly.COLOR.BLUE)\nlogly.critical(\"Key5\", \"Value5\", color=logly.COLOR.CRITICAL)\nlogly.fatal(\"Key6\", \"Value6\", color=logly.COLOR.CRITICAL)\nlogly.trace(\"Key7\", \"Value7\", color=logly.COLOR.BLUE)\nlogly.log(\"Key8\", \"Value8\", color=logly.COLOR.WHITE)\n\n# Stop logging (messages will be displayed but not logged in file after this point)\nlogly.stop_logging()\n\n# Log more messages after stopping logging (messages will be displayed but not logged in file after this point)\nlogly.info(\"AnotherKey1\", \"AnotherValue1\", color=logly.COLOR.CYAN)\nlogly.warn(\"AnotherKey2\", \"AnotherValue2\", color=logly.COLOR.YELLOW)\nlogly.error(\"AnotherKey3\", \"AnotherValue3\", color=logly.COLOR.RED)\n\n\nlogly.info(\"hello this is log\", color=logly.COLOR.RED,show_time=False) # with custom color and without time\n\n# Start logging again\nlogly.start_logging() \n\n# Set the default file path and max file size\nlogly.set_default_file_path(\"log.txt\") # Set the default file path is \"log.txt\" if you want to set the file path where you want to save the log file.\nlogly.set_default_max_file_size(50) # set default max file size is 50 MB\n\n# Log messages with default settings (using default file path and max file size)\nlogly.info(\"DefaultKey1\", \"DefaultValue1\")\nlogly.warn(\"DefaultKey2\", \"DefaultValue2\")\nlogly.error(\"DefaultKey3\", \"DefaultValue3\", log_to_file=False)\n\n#The DEFAULT FILE SIZE IS 100 MB in the txt file\n# Log messages with custom file path and max file size(optional)\nlogly.info(\"CustomKey1\", \"CustomValue1\", file_path=\"path/c.txt\", max_file_size=25) # max_file_size is in MB and create a new file when the file size reaches max_file_size\nlogly.warn(\"CustomKey2\", \"CustomValue2\", file_path=\"path/c.txt\", max_file_size=25,auto=True) # auto=True will automatically delete the file data when it reaches max_file_size\n\n# Access color constants directly\nlogly.info(\"Accessing color directly\", \"DirectColorValue\", color=logly.COLOR.RED)\n\n# Disable color\nlogly.color_enabled = False\nlogly.info(\"ColorDisabledKey\", \"ColorDisabledValue\", color=logly.COLOR.RED)\nlogly.info(\"ColorDisabledKey1\", \"ColorDisabledValue1\", color=logly.COLOR.RED,color_enabled=True) # This will enable the color for this one log message\nlogly.color_enabled = True\n# this will enable the color again\nlogly.info(\"ColorDisabledKey1\", \"ColorDisabledValue1\", color=logly.COLOR.RED,color_enabled=False) # this will disable the color for this one log message\n\n\n# Display logged messages (this will display all the messages logged so far)\nprint(\"Logged Messages:\")\nfor message in logly.logged_messages:\n print(message)\n\n```\n## Explanation:\n\n1. Import the `Logly` class from the `logly` module.\n2. Create an instance of `Logly`.\n3. Start logging using the `start_logging()` method.\n4. Log messages with various levels (info, warn, error, debug, critical, fatal, trace) and colors.\n5. Stop logging using the `stop_logging()` method.\n6. Log additional messages after stopping logging.\n7. Start logging again.\n8. Log messages with default settings, custom file path, and max file size.\n9. Access color constants directly.\n10. Display logged messages.\n11. enable/disable timestamp support\n12. enable/disable color for log support\n\nfor more information, check the [repository](https://github.com/muhammad-fiaz/logly)\n\n## Set the Default Path\n\nIf you encounter an error related to the default file path, you can use the following code snippet to set the default path:\n\n```python3\nimport os\nfrom logly import Logly\n\nlogly = Logly()\nlogly.start_logging()\n\n# Set the default file path and maximum file size\nlogly.set_default_max_file_size(50)\nlogger = os.path.join(os.path.dirname(os.path.abspath(__file__)), \"log.txt\")\nlogly.set_default_file_path(logger)\n```\nThis will set the default file path, and you can customize it according to your requirements.\n\nif you want to set the default path for the log file, you can use the following code snippet\n\n```python3\nfrom logly import Logly\nlogly = Logly()\nlogly.set_default_file_path(\"log.txt\")\n```\n\nif you faced an error like [`FileNotFoundError: [Errno 2] No such file or directory: 'log.txt'`](https://github.com/muhammad-fiaz/logly/issues/4) you can use the following code snippet to set the default path\n\n```python3\nimport os\nfrom logly import Logly\n\nlogly = Logly() # initialize the logly\nlogly.start_logging() # make sure to include this or else the log will only display without storing it\n\nlogly.set_default_max_file_size(50) # optional\nlogger = os.path.join(os.path.dirname(os.path.abspath(__file__)), \"log.txt\") # This will ensure the path location to create the log.txt on current directory\nlogly.set_default_file_path(logger)\n```\nfor more information, check the [repository](https://github.com/muhammad-fiaz/logly).\n\n## Color Options:\n\n### Default Color Options:\n\n| Level | Color Code |\n| -------- | --------------- |\n| INFO | CYAN |\n| WARNING | YELLOW |\n| ERROR | RED |\n| DEBUG | BLUE |\n| CRITICAL | BRIGHT RED |\n| TRACE | BLUE |\n| DEFAULT | WHITE |\n\n### Custom Color Options:\n\nYou can use any of the following color codes for custom coloring:\n\n| NAME | Color Code |\n|----------| --------------- |\n| CYAN | CYAN |\n| YELLOW | YELLOW |\n| RED | RED |\n| BLUE | BLUE |\n| BRIGHT RED | CRITICAL |\n|WHITE | WHITE |\n\nFor example, you can use `color=logly.COLOR.RED` for the red color.\n\n## Tips & Tricks\nIf you want to use logly in your project files without creating a new object in each Python file or class, you can create a file named logly.py. In this file, initialize logly and configure the defaults. Now, you can easily import and use it throughout your project:\n\n`logly.py`\n```python3\n# logly.py in your root or custom path\n# Import Logly\n\nfrom logly import Logly\nimport os\nlogly = Logly()\nlogly.start_logging()\n\n# Set the default file path and maximum file size\nlogly.set_default_max_file_size(50)\nlogger = os.path.join(os.path.dirname(os.path.abspath(__file__)), \"log.txt\") # This will ensure the path location to create the log.txt \nlogly.set_default_file_path(logger)\n\n# Start logging again\nlogly.start_logging()\n```\nyou can now use the logly by\n\n\n`main.py`\n```python3\nfrom logly import logly # make sure to import it some IDE may automatically import it on top\n\nlogly.info(\"msg\",\"hello this is logly\", color=logly.COLOR.RED) # with custom color of red\n\n```\n### output \n```\n[XXXX-XX-XX XX:XX: XX] INFo: msg: hello this is logly\n\n```\n\n## Contributing\nContributions are welcome! Before contributing, please read our [Contributing Guidelines](CONTRIBUTING.md) to ensure a smooth and collaborative development process.\n\n## Code of Conduct\n\nPlease review our [Code of Conduct](CODE_OF_CONDUCT.md) to understand the standards of behavior we expect from contributors and users of this project.\n\n## License\nThis project is licensed under the [MIT License](). See [LICENSE](LICENSE) for more details.\n\n## Support the Project\n<br>\n<div align=\"center\">\n\n_Support the Project by Becoming a Sponsor on GitHub_\n\n[](https://github.com/sponsors/muhammad-fiaz)\n\n\n</div>\n\n\n\n## Happy Coding\n\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Logly: Ready to Go Python logging utility with color-coded messages, file-based logging, and many more customizable options. Simplify logging in your Python applications with Logly.",
"version": "0.0.6",
"project_urls": {
"Bug Tracker": "https://github.com/muhammad-fiaz/logly/issues",
"Documentation": "https://github.com/muhammad-fiaz/logly#readme",
"Homepage": "https://github.com/muhammad-fiaz/logly.git",
"Source Code": "https://github.com/muhammad-fiaz/logly.git"
},
"split_keywords": [
"log",
" logging",
" logly",
" python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8dc524e0772530a2bc8eecb8f306d9c68680599d829ccac65eeb8b0892793680",
"md5": "13fca443fa198d17ca1af5625e681462",
"sha256": "bb31c20be6e2b6c827106639dddacbd6fb77603bca6a25c1a10c762d6f3d25c6"
},
"downloads": -1,
"filename": "logly-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "13fca443fa198d17ca1af5625e681462",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 14969,
"upload_time": "2024-03-28T15:26:50",
"upload_time_iso_8601": "2024-03-28T15:26:50.869135Z",
"url": "https://files.pythonhosted.org/packages/8d/c5/24e0772530a2bc8eecb8f306d9c68680599d829ccac65eeb8b0892793680/logly-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-28 15:26:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "muhammad-fiaz",
"github_project": "logly",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "logly"
}
JSON
