logly
v0.0.6
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 and if you want to contribute make sure to fork this repository❤.
pip install logly# 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 in file
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)Logly class from the logly module.Logly.start_logging() method.stop_logging() method.for more information, check the repository
If you encounter an error related to the default file path, you can use the following code snippet to set the default path:
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
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' you can use the following code snippet to set the default path
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.
| Level | Color Code |
|---|---|
| INFO | CYAN |
| WARNING | YELLOW |
| ERROR | RED |
| DEBUG | BLUE |
| CRITICAL | BRIGHT RED |
| TRACE | BLUE |
| DEFAULT | WHITE |
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.
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
# 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
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[XXXX-XX-XX XX:XX: XX] INFo: msg: hello this is logly
Contributions are welcome! Before contributing, please read our Contributing Guidelines to ensure a smooth and collaborative development process.
Please review our Code of Conduct to understand the standards of behavior we expect from contributors and users of this project.
This project is licensed under the MIT License. See LICENSE for more details.
Support the Project by Becoming a Sponsor on GitHub
