v0.0.6 (#20)

* v0.0.6 pre -> added logo and doc improvements

.gitignore

@@ -0,0 +1,4 @@
+.venv
+.idea
+*.iml
+*.ipr

README.md

@@ -1,6 +1,6 @@
 <div align="center">
 
-<img src="https://private-user-images.githubusercontent.com/75434191/307529707-500975cc-b5f4-46df-abe8-2d03c687a1c1.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MTA1MTMwMjQsIm5iZiI6MTcxMDUxMjcyNCwicGF0aCI6Ii83NTQzNDE5MS8zMDc1Mjk3MDctNTAwOTc1Y2MtYjVmNC00NmRmLWFiZTgtMmQwM2M2ODdhMWMxLnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDAzMTUlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwMzE1VDE0MjUyNFomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPTAxMmUzMDRjMmE4OGY1MzQ1M2YwZjNkZTUxZmQ3MTMxNzM0NjE3ODRmNjI3ZTJjNWY4Mjk4Nzk1NGQwN2JmMjMmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.H9MOqp4Xg3GJd1B2W4U7FpHz0KTjcJuuePBOUKtuVkQ" alt="Sample Image">
+<img src="assets/logly_logo.png" alt="Sample Image">
 
 
 # Logly
@@ -22,14 +22,15 @@
 
 </div>
 
+Tired of writing custom logging code for your Python applications? 
 
-Logly is a customizable logging utility for Python that provides an easy way to log messages with different levels, colors, and 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.
+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❤✨.
+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](#readme)
+1. [Introduction](#)
 2. [Installation](#installation)
 3. [Features](#features)
 4. [Usage](#usage)
@@ -46,6 +47,7 @@ if you like this project make sure to star 🌟 it in the [repository](https://g
 11. [Support the Project](#support-the-project)
 12. [Happy Coding](#happy-coding)
 
+
 ## Features
 
 - Easy-to-use logging for Python applications.
@@ -55,7 +57,10 @@ if you like this project make sure to star 🌟 it in the [repository](https://g
 - 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.
+- 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
 
@@ -91,10 +96,10 @@ 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)
+# 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)
+# 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)
@@ -105,7 +110,7 @@ logly.info("hello this is log", color=logly.COLOR.RED,show_time=False) # with cu
 # Start logging again
 logly.start_logging() 
 
-# Set default file path and max file size
+# 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
 
@@ -114,7 +119,7 @@ logly.info("DefaultKey1", "DefaultValue1")
 logly.warn("DefaultKey2", "DefaultValue2")
 logly.error("DefaultKey3", "DefaultValue3", log_to_file=False)
 
-#DEFAULT FILE SIZE IS 100 MB in the txt file
+#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
@@ -152,22 +157,49 @@ for message in logly.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)
+for more information, check the [repository](https://github.com/muhammad-fiaz/logly)
+
+## Set the Default Path
 
-## Set 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 default file path and maximum file size
+# 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:
@@ -195,7 +227,7 @@ You can use any of the following color codes for custom coloring:
 | BRIGHT RED | CRITICAL     |
 |WHITE   | WHITE           |
 
-For example, you can use `color=logly.COLOR.BLACK` for the black color.
+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:
@@ -204,12 +236,13 @@ If you want to use logly in your project files without creating a new object in
 ```python3
 # logly.py in your root or custom path
 # Import Logly
-from logly import Logly
 
+from logly import Logly
+import os
 logly = Logly()
 logly.start_logging()
 
-# Set default file path and maximum file size
+# 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)
@@ -247,13 +280,13 @@ This project is licensed under the [MIT License](). See [LICENSE](LICENSE) for m
 <br>
 <div align="center">
 
-<h5> <strong> 💰 You can help me improve more by offering a little support on any platform❤️</strong></h5>
-
+_Support the Project by Becoming a Sponsor on GitHub_
 
 [![Sponsor muhammad-fiaz](https://img.shields.io/badge/Sponsor-%231EAEDB.svg?&style=for-the-badge&logo=GitHub-Sponsors&logoColor=white)](https://github.com/sponsors/muhammad-fiaz)
 
+
 </div>
 
 
 
-## Happy Coding ❤️
+## Happy Coding

logly/__init__.py

@@ -1,6 +1,6 @@
 # Example usage:
 """
-Logly: A simple logging utility.
+Logly: A ready to go logging utility.
 
 Copyright (c) 2023 Muhammad Fiaz
 

logly/exception.py

@@ -1,5 +1,5 @@
 """
-Logly: A simple logging utility.
+Logly: A ready to go logging utility.
 
 Copyright (c) 2023 Muhammad Fiaz
 

logly/logly.py

@@ -1,7 +1,7 @@
 # logly.py
 # # Path: logly/logly.py
 """
-Logly: A simple logging utility.
+Logly: A ready to go logging utility.
 
 Copyright (c) 2023 Muhammad Fiaz
 
@@ -15,13 +15,12 @@
 along with Logly. If not, see <https://opensource.org/licenses/MIT>.
 """
 
-
 import os
 from colorama import Fore, Style, init
 from datetime import datetime
 import re
 
-from logly.exception import FilePathNotFoundException, FileAccessError, FileCreationError, LoglyException
+from logly.exception import FilePathNotFoundException, FileAccessError, FileCreationError
 
 init(autoreset=True)
 
@@ -148,7 +147,7 @@ def get_current_datetime(self):
 
     def remove_color_codes(self, text):
         """
-        Remove ANSI color codes from text.
+        Remove ANSI color codes from a text.
 
         Parameters:
         - text (str): Input text with color codes.
@@ -245,7 +244,7 @@ def _log(self, level, key, value, color=None, log_to_file=True, file_path=None,
                             count += 1
                         file_path = f"{file_base}_{count}{file_ext}"
 
-                # Open the file in append mode, creating it if it doesn't exist
+                # Open the file in appended mode, creating it if it doesn't exist
                 with open(file_path, "a" if file_exists else "w") as log_file:
                     log_file.write(log_message_without_color + "\n")
 
@@ -257,7 +256,7 @@ def _log(self, level, key, value, color=None, log_to_file=True, file_path=None,
                 raise FileCreationError(f"Error creating or writing to the log file: {e}")
 
     def log_function(self, level, key_or_value, value=None, color=None, log_to_file=True, file_path=None,
-                     file_name=None, max_file_size=None, auto=True, show_time=None,color_enabled=None):
+                     file_name=None, max_file_size=None, auto=True, show_time=None, color_enabled=None):
         """
         Log a message with exception handling.
 
@@ -282,10 +281,11 @@ def log_function(self, level, key_or_value, value=None, color=None, log_to_file=
             # If two parameters are provided, consider the first as the key and the second as the value
             key = key_or_value
 
-        self._log(level, key, value, color, log_to_file, file_path, file_name, max_file_size, auto, show_time,color_enabled)
+        self._log(level, key, value, color, log_to_file, file_path, file_name, max_file_size, auto, show_time,
+                  color_enabled)
 
     def info(self, key_or_value, value=None, color=None, log_to_file=True, file_path=None, file_name=None,
-             max_file_size=None, auto=True, show_time=None,color_enabled=None):
+             max_file_size=None, auto=True, show_time=None, color_enabled=None):
         """
         Log a message with the INFO level.
 
@@ -302,10 +302,10 @@ def info(self, key_or_value, value=None, color=None, log_to_file=True, file_path
         - show_time (bool, optional): Whether to include timestamps in the log message. Defaults to None.
         """
         self.log_function("INFO", key_or_value, value, color, log_to_file, file_path, file_name, max_file_size, auto,
-                          show_time,color_enabled)
+                          show_time, color_enabled)
 
     def warn(self, key_or_value, value=None, color=None, log_to_file=True, file_path=None, file_name=None,
-             max_file_size=None, auto=True, show_time=None,color_enabled=None):
+             max_file_size=None, auto=True, show_time=None, color_enabled=None):
         """
         Log a message with the WARNING level.
 
@@ -322,10 +322,10 @@ def warn(self, key_or_value, value=None, color=None, log_to_file=True, file_path
         - show_time (bool, optional): Whether to include timestamps in the log message. Defaults to None.
         """
         self.log_function("WARNING", key_or_value, value, color, log_to_file, file_path, file_name, max_file_size, auto,
-                          show_time,color_enabled)
+                          show_time, color_enabled)
 
     def error(self, key_or_value, value=None, color=None, log_to_file=True, file_path=None, file_name=None,
-              max_file_size=None, auto=True, show_time=None,color_enabled=None):
+              max_file_size=None, auto=True, show_time=None, color_enabled=None):
         """
         Log a message with the ERROR level.
 
@@ -342,10 +342,10 @@ def error(self, key_or_value, value=None, color=None, log_to_file=True, file_pat
         - show_time (bool, optional): Whether to include timestamps in the log message. Defaults to None.
         """
         self.log_function("ERROR", key_or_value, value, color, log_to_file, file_path, file_name, max_file_size, auto,
-                          show_time,color_enabled)
+                          show_time, color_enabled)
 
     def debug(self, key_or_value, value=None, color=None, log_to_file=True, file_path=None, file_name=None,
-              max_file_size=None, auto=True, show_time=None,color_enabled=None):
+              max_file_size=None, auto=True, show_time=None, color_enabled=None):
         """
         Log a message with the DEBUG level.
 
@@ -362,10 +362,10 @@ def debug(self, key_or_value, value=None, color=None, log_to_file=True, file_pat
         - show_time (bool, optional): Whether to include timestamps in the log message. Defaults to None.
         """
         self.log_function("DEBUG", key_or_value, value, color, log_to_file, file_path, file_name, max_file_size, auto,
-                          show_time,color_enabled)
+                          show_time, color_enabled)
 
     def critical(self, key_or_value, value=None, color=None, log_to_file=True, file_path=None, file_name=None,
-                 max_file_size=None, auto=True, show_time=None,color_enabled=None):
+                 max_file_size=None, auto=True, show_time=None, color_enabled=None):
         """
         Log a critical message.
 
@@ -383,10 +383,10 @@ def critical(self, key_or_value, value=None, color=None, log_to_file=True, file_
         """
         self.log_function("CRITICAL", key_or_value, value, color, log_to_file, file_path, file_name, max_file_size,
                           auto,
-                          show_time,color_enabled)
+                          show_time, color_enabled)
 
     def fatal(self, key_or_value, value=None, color=None, log_to_file=True, file_path=None, file_name=None,
-              max_file_size=None, auto=True, show_time=None,color_enabled=None):
+              max_file_size=None, auto=True, show_time=None, color_enabled=None):
         """
         Log a fatal message.
 
@@ -403,10 +403,10 @@ def fatal(self, key_or_value, value=None, color=None, log_to_file=True, file_pat
         - show_time (bool, optional): Whether to include timestamps in the log message. Defaults to None.
         """
         self.log_function("FATAL", key_or_value, value, color, log_to_file, file_path, file_name, max_file_size, auto,
-                          show_time,color_enabled)
+                          show_time, color_enabled)
 
     def trace(self, key_or_value, value=None, color=None, log_to_file=True, file_path=None, file_name=None,
-              max_file_size=None, auto=True, show_time=None,color_enabled=None):
+              max_file_size=None, auto=True, show_time=None, color_enabled=None):
         """
         Log a trace message.
 
@@ -423,10 +423,10 @@ def trace(self, key_or_value, value=None, color=None, log_to_file=True, file_pat
         - show_time (bool, optional): Whether to include timestamps in the log message. Defaults to None.
         """
         self.log_function("TRACE", key_or_value, value, color, log_to_file, file_path, file_name, max_file_size, auto,
-                          show_time,color_enabled)
+                          show_time, color_enabled)
 
     def log(self, key_or_value, value=None, color=None, log_to_file=True, file_path=None, file_name=None,
-            max_file_size=None, auto=True, show_time=None,color_enabled=None):
+            max_file_size=None, auto=True, show_time=None, color_enabled=None):
         """
         Log an info message.
 
@@ -443,4 +443,4 @@ def log(self, key_or_value, value=None, color=None, log_to_file=True, file_path=
         - show_time (bool, optional): Whether to include timestamps in the log message. Defaults to None.
         """
         self.log_function("LOG", key_or_value, value, color, log_to_file, file_path, file_name, max_file_size, auto,
-                          show_time,color_enabled)
+                          show_time, color_enabled)

logly/version.py

@@ -1,7 +1,7 @@
 
 # version.py
 """
-Logly: A simple logging utility.
+Logly: A ready to go logging utility.
 
 Copyright (c) 2023 Muhammad Fiaz
 

setup.py

@@ -1,8 +1,8 @@
 from setuptools import setup, find_packages
 
-VERSION = "0.0.5"
+VERSION = "0.0.6"
 
-DESCRIPTION = 'Logly: Python logging utility with color-coded messages and file support. Easily log and trace messages with customizable colors. Simple integration for effective debugging and monitoring.'
+DESCRIPTION = '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.'
 
 with open("README.md", "r", encoding="utf-8") as fh:
     LONG_DESCRIPTION = fh.read()