custom-python-logger 1.0.9__tar.gz → 1.0.11__tar.gz

custom_python_logger-1.0.11/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: custom-python-logger
+Version: 1.0.11
+Summary: A custom logger with color support and additional features.
+Home-page: https://github.com/aviz92/custom-python-logger
+Author: Avi Zaguri
+Author-email: 
+Project-URL: Repository, https://github.com/aviz92/custom-python-logger
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: setuptools
+Requires-Dist: wheel
+Requires-Dist: colorlog
+Requires-Dist: pytest
+Requires-Dist: pathlib
+Requires-Dist: PyYAML
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# custom-python-logger
+A powerful and flexible Python logger with colored output, custom log levels, and advanced configuration options. <br>
+Easily integrate structured, readable, and context-rich logging into your Python projects for better debugging and monitoring.
+
+---
+
+## 🚀 Features
+- ✅ **Colored Output**: Beautiful, readable logs in your terminal using `colorlog`.
+- ✅ **Custom Log Levels**: Includes `STEP` (for process steps) and `EXCEPTION` (for exception tracking) in addition to standard levels.
+- ✅ **Flexible Output**: Log to console, file, or both. Supports custom log file paths and automatic log directory creation.
+- ✅ **Contextual Logging**: Add extra fields (like user, environment, etc.) to every log message.
+- ✅ **UTC Support**: Optionally log timestamps in UTC for consistency across environments.
+- ✅ **Pretty Formatting**: Built-in helpers for pretty-printing JSON and YAML data in logs.
+- ✅ **Easy Integration**: Simple API for getting a ready-to-use logger anywhere in your codebase.
+
+---
+
+## 📦 Installation
+```bash
+pip install custom-python-logger
+```
+
+---
+
+### 🔧 Usage
+Here's a quick example of how to use `custom-python-logger` in your project:
+
+```python
+import logging
+from custom_python_logger import get_logger, CustomLoggerAdapter
+
+logger: CustomLoggerAdapter = get_logger(
+    project_name='Logger Project Test',
+    log_level=logging.DEBUG,
+    log_file=True,
+)
+
+logger.debug("This is a debug message.")
+logger.info("This is an info message.")
+logger.step("This is a step message.")
+logger.warning("This is a warning message.")
+
+try:
+    _ = 1 / 0
+except ZeroDivisionError:
+    logger.exception("This is an exception message.")
+
+logger.critical("This is a critical message.")
+```
+
+#### Advanced Usage
+- Log to a file:
+  ```python
+  from custom_python_logger import get_logger, CustomLoggerAdapter
+
+  logger = get_logger(project_name='MyApp', log_file=True)
+  ```
+- Use UTC timestamps:
+  ```python
+  from custom_python_logger import get_logger, CustomLoggerAdapter
+
+  logger = get_logger(project_name='MyApp', log_file=True, utc=True)
+  ```
+- Add extra context:
+  ```python
+  from custom_python_logger import get_logger, CustomLoggerAdapter
+
+  logger = get_logger(project_name='MyApp', log_file=True, utc=True, extra={'user': 'alice'})
+  ```
+- Pretty-print JSON or YAML:
+  ```python
+  from custom_python_logger import get_logger, CustomLoggerAdapter, json_pretty_format, yaml_pretty_format
+
+  logger = get_logger(project_name='MyApp', utc=True, log_file=True)
+
+  logger.info(json_pretty_format({'foo': 'bar'}))
+  logger.info(yaml_pretty_format({'foo': 'bar'}))
+  ```
+
+---
+
+## 🤝 Contributing
+If you have a helpful tool, pattern, or improvement to suggest:
+Fork the repo <br>
+Create a new branch <br>
+Submit a pull request <br>
+I welcome additions that promote clean, productive, and maintainable development. <br>
+
+---
+
+## 📄 License
+MIT License — see [LICENSE](LICENSE) for details.
+
+---
+
+## 🙏 Thanks
+Thanks for exploring this repository! <br>
+Happy coding! <br>

custom_python_logger-1.0.11/README.md

@@ -0,0 +1,98 @@
+# custom-python-logger
+A powerful and flexible Python logger with colored output, custom log levels, and advanced configuration options. <br>
+Easily integrate structured, readable, and context-rich logging into your Python projects for better debugging and monitoring.
+
+---
+
+## 🚀 Features
+- ✅ **Colored Output**: Beautiful, readable logs in your terminal using `colorlog`.
+- ✅ **Custom Log Levels**: Includes `STEP` (for process steps) and `EXCEPTION` (for exception tracking) in addition to standard levels.
+- ✅ **Flexible Output**: Log to console, file, or both. Supports custom log file paths and automatic log directory creation.
+- ✅ **Contextual Logging**: Add extra fields (like user, environment, etc.) to every log message.
+- ✅ **UTC Support**: Optionally log timestamps in UTC for consistency across environments.
+- ✅ **Pretty Formatting**: Built-in helpers for pretty-printing JSON and YAML data in logs.
+- ✅ **Easy Integration**: Simple API for getting a ready-to-use logger anywhere in your codebase.
+
+---
+
+## 📦 Installation
+```bash
+pip install custom-python-logger
+```
+
+---
+
+### 🔧 Usage
+Here's a quick example of how to use `custom-python-logger` in your project:
+
+```python
+import logging
+from custom_python_logger import get_logger, CustomLoggerAdapter
+
+logger: CustomLoggerAdapter = get_logger(
+    project_name='Logger Project Test',
+    log_level=logging.DEBUG,
+    log_file=True,
+)
+
+logger.debug("This is a debug message.")
+logger.info("This is an info message.")
+logger.step("This is a step message.")
+logger.warning("This is a warning message.")
+
+try:
+    _ = 1 / 0
+except ZeroDivisionError:
+    logger.exception("This is an exception message.")
+
+logger.critical("This is a critical message.")
+```
+
+#### Advanced Usage
+- Log to a file:
+  ```python
+  from custom_python_logger import get_logger, CustomLoggerAdapter
+
+  logger = get_logger(project_name='MyApp', log_file=True)
+  ```
+- Use UTC timestamps:
+  ```python
+  from custom_python_logger import get_logger, CustomLoggerAdapter
+
+  logger = get_logger(project_name='MyApp', log_file=True, utc=True)
+  ```
+- Add extra context:
+  ```python
+  from custom_python_logger import get_logger, CustomLoggerAdapter
+
+  logger = get_logger(project_name='MyApp', log_file=True, utc=True, extra={'user': 'alice'})
+  ```
+- Pretty-print JSON or YAML:
+  ```python
+  from custom_python_logger import get_logger, CustomLoggerAdapter, json_pretty_format, yaml_pretty_format
+
+  logger = get_logger(project_name='MyApp', utc=True, log_file=True)
+
+  logger.info(json_pretty_format({'foo': 'bar'}))
+  logger.info(yaml_pretty_format({'foo': 'bar'}))
+  ```
+
+---
+
+## 🤝 Contributing
+If you have a helpful tool, pattern, or improvement to suggest:
+Fork the repo <br>
+Create a new branch <br>
+Submit a pull request <br>
+I welcome additions that promote clean, productive, and maintainable development. <br>
+
+---
+
+## 📄 License
+MIT License — see [LICENSE](LICENSE) for details.
+
+---
+
+## 🙏 Thanks
+Thanks for exploring this repository! <br>
+Happy coding! <br>

{custom_python_logger-1.0.9 → custom_python_logger-1.0.11}/custom_python_logger/logger.py

@@ -44,7 +44,8 @@ def configure_logging(
         log_format: str,
         utc: bool,
         log_level: int = logging.INFO,
-        log_file: Optional[str] = None,
+        log_file: bool = False,
+        log_file_path: Optional[str] = None,
         console_output: bool = True,
 ) -> None:
     """
@@ -53,7 +54,8 @@ def configure_logging(
     Args:
         log_level: Logging level (default: INFO)
         log_format: Format string for log messages
-        log_file: Path to log file (if None, no file logging)
+        log_file: Whether to log to a file
+        log_file_path: Path to log file (if None, no file logging)
         console_output: Whether to output logs to console
         utc: Whether to use UTC time for log timestamps
     """
@@ -68,15 +70,15 @@ def configure_logging(
         root_logger.removeHandler(handler)
 
     # Add file handler if specified
-    if log_file is not None:
+    if log_file and log_file_path is not None:
         log_file_formatter = logging.Formatter(log_format)
 
         # Create directory if it doesn't exist
-        log_dir = os.path.dirname(log_file)
+        log_dir = os.path.dirname(log_file_path)
         if log_dir and not os.path.exists(log_dir):
             os.makedirs(log_dir)
 
-        file_handler = logging.FileHandler(log_file)
+        file_handler = logging.FileHandler(log_file_path)
 
         file_handler.setFormatter(log_file_formatter)
         root_logger.addHandler(file_handler)
@@ -107,7 +109,8 @@ def get_logger(
         extra: Optional[dict[str, Any]] = None,
         log_format: str = "%(asctime)s | %(levelname)-10s(l.%(levelno)s) | %(filename)s:%(lineno)s | %(message)s",
         log_level: int = logging.INFO,
-        log_file: str = None,
+        log_file: bool = False,
+        log_file_path: str = None,
         console_output: bool = True,
         utc: bool = False,
 ) -> CustomLoggerAdapter[Logger | LoggerAdapter[Any] | Any] | Logger:
@@ -119,7 +122,8 @@ def get_logger(
         log_level: Optional specific log level
         extra: Optional dictionary of extra context values
         log_format: Format string for log messages
-        log_file: Path to log file (if None, no file logging)
+        log_file: Whether to log to a file
+        log_file_path: Path to log file (if None, no file logging)
         console_output: Whether to output logs to console
         utc: Whether to use UTC time for log timestamps
 
@@ -128,14 +132,15 @@ def get_logger(
     """
     print_before_logger(project_name=project_name)
 
-    if not log_file:
-        log_file = f'{get_root_project_path()}/logs/{project_name}.log'
-        log_file = log_file.lower().replace(' ', '_')
+    if not log_file_path:
+        log_file_path = f'{get_root_project_path()}/logs/{project_name}.log'
+        log_file_path = log_file_path.lower().replace(' ', '_')
 
     configure_logging(
         log_level=logging.DEBUG,
         log_format=log_format,
         log_file=log_file,
+        log_file_path=log_file_path,
         console_output=console_output,
         utc=utc
     )

{custom_python_logger-1.0.9 → custom_python_logger-1.0.11}/custom_python_logger/usage_example.py

@@ -1,4 +1,5 @@
 import logging
+from custom_python_logger import get_logger
 
 
 class LoggerTest:
@@ -11,11 +12,10 @@ class LoggerTest:
 
 
 def main():
-    from custom_python_logger.logger import get_logger
-
     logger = get_logger(
         project_name='Logger Project Test',
         log_level=logging.DEBUG,
+        log_file=True,
         # extra={'user': 'test_user'}
     )
 

custom_python_logger-1.0.11/custom_python_logger.egg-info/PKG-INFO

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: custom-python-logger
+Version: 1.0.11
+Summary: A custom logger with color support and additional features.
+Home-page: https://github.com/aviz92/custom-python-logger
+Author: Avi Zaguri
+Author-email: 
+Project-URL: Repository, https://github.com/aviz92/custom-python-logger
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: setuptools
+Requires-Dist: wheel
+Requires-Dist: colorlog
+Requires-Dist: pytest
+Requires-Dist: pathlib
+Requires-Dist: PyYAML
+Dynamic: author
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# custom-python-logger
+A powerful and flexible Python logger with colored output, custom log levels, and advanced configuration options. <br>
+Easily integrate structured, readable, and context-rich logging into your Python projects for better debugging and monitoring.
+
+---
+
+## 🚀 Features
+- ✅ **Colored Output**: Beautiful, readable logs in your terminal using `colorlog`.
+- ✅ **Custom Log Levels**: Includes `STEP` (for process steps) and `EXCEPTION` (for exception tracking) in addition to standard levels.
+- ✅ **Flexible Output**: Log to console, file, or both. Supports custom log file paths and automatic log directory creation.
+- ✅ **Contextual Logging**: Add extra fields (like user, environment, etc.) to every log message.
+- ✅ **UTC Support**: Optionally log timestamps in UTC for consistency across environments.
+- ✅ **Pretty Formatting**: Built-in helpers for pretty-printing JSON and YAML data in logs.
+- ✅ **Easy Integration**: Simple API for getting a ready-to-use logger anywhere in your codebase.
+
+---
+
+## 📦 Installation
+```bash
+pip install custom-python-logger
+```
+
+---
+
+### 🔧 Usage
+Here's a quick example of how to use `custom-python-logger` in your project:
+
+```python
+import logging
+from custom_python_logger import get_logger, CustomLoggerAdapter
+
+logger: CustomLoggerAdapter = get_logger(
+    project_name='Logger Project Test',
+    log_level=logging.DEBUG,
+    log_file=True,
+)
+
+logger.debug("This is a debug message.")
+logger.info("This is an info message.")
+logger.step("This is a step message.")
+logger.warning("This is a warning message.")
+
+try:
+    _ = 1 / 0
+except ZeroDivisionError:
+    logger.exception("This is an exception message.")
+
+logger.critical("This is a critical message.")
+```
+
+#### Advanced Usage
+- Log to a file:
+  ```python
+  from custom_python_logger import get_logger, CustomLoggerAdapter
+
+  logger = get_logger(project_name='MyApp', log_file=True)
+  ```
+- Use UTC timestamps:
+  ```python
+  from custom_python_logger import get_logger, CustomLoggerAdapter
+
+  logger = get_logger(project_name='MyApp', log_file=True, utc=True)
+  ```
+- Add extra context:
+  ```python
+  from custom_python_logger import get_logger, CustomLoggerAdapter
+
+  logger = get_logger(project_name='MyApp', log_file=True, utc=True, extra={'user': 'alice'})
+  ```
+- Pretty-print JSON or YAML:
+  ```python
+  from custom_python_logger import get_logger, CustomLoggerAdapter, json_pretty_format, yaml_pretty_format
+
+  logger = get_logger(project_name='MyApp', utc=True, log_file=True)
+
+  logger.info(json_pretty_format({'foo': 'bar'}))
+  logger.info(yaml_pretty_format({'foo': 'bar'}))
+  ```
+
+---
+
+## 🤝 Contributing
+If you have a helpful tool, pattern, or improvement to suggest:
+Fork the repo <br>
+Create a new branch <br>
+Submit a pull request <br>
+I welcome additions that promote clean, productive, and maintainable development. <br>
+
+---
+
+## 📄 License
+MIT License — see [LICENSE](LICENSE) for details.
+
+---
+
+## 🙏 Thanks
+Thanks for exploring this repository! <br>
+Happy coding! <br>

{custom_python_logger-1.0.9 → custom_python_logger-1.0.11}/setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-package_version = '1.0.9'
+package_version = '1.0.11'
 
 package_name = 'custom-python-logger'
 package_description = 'A custom logger with color support and additional features.'

custom_python_logger-1.0.9/PKG-INFO

@@ -1,83 +0,0 @@
-Metadata-Version: 2.4
-Name: custom-python-logger
-Version: 1.0.9
-Summary: A custom logger with color support and additional features.
-Home-page: https://github.com/aviz92/custom-python-logger
-Author: Avi Zaguri
-Author-email: 
-Project-URL: Repository, https://github.com/aviz92/custom-python-logger
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: setuptools
-Requires-Dist: wheel
-Requires-Dist: colorlog
-Requires-Dist: pytest
-Requires-Dist: pathlib
-Requires-Dist: PyYAML
-Dynamic: author
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# Custom Logger
-A Python logger with colored output and additional log levels. <br> 
-The logger supports custom log levels like `STEP` and `EXCEPTION` and can be easily integrated into your Python projects.
-
-## Installation
-You can install the package using pip:
-```bash
-pip install custom-python-logger
-```
-
-## Usage
-```python
-import logging
-from custom_python_logger.logger import get_logger, CustomLoggerAdapter
-
-logger: CustomLoggerAdapter = CustomLoggerAdapter(logging.getLogger(__name__))
-
-
-def main():
-    logger.debug("This is a debug message.")
-    logger.info("This is an info message.")
-    logger.step("This is a step message.")
-    logger.warning("This is a warning message.")
-
-    try:
-        _ = 1 / 0
-    except ZeroDivisionError:
-        logger.exception("This is an exception message.")
-
-    logger.critical("This is a critical message.")
-
-
-if __name__ == '__main__':
-    _ = get_logger(
-        project_name='Logger Project Test',
-        log_level=logging.DEBUG,
-        extra={'user': 'test_user'}
-    )
-
-    main()
-```
-
----
-
-## 🤝 Contributing
-If you have a helpful tool, pattern, or improvement to suggest:
-Fork the repo <br>
-Create a new branch <br>
-Submit a pull request <br>
-I welcome additions that promote clean, productive, and maintainable development. <br>
-
----
-
-## 🙏 Thanks
-Thanks for exploring this repository! <br>
-Happy coding! <br>

custom_python_logger-1.0.9/README.md

@@ -1,56 +0,0 @@
-# Custom Logger
-A Python logger with colored output and additional log levels. <br> 
-The logger supports custom log levels like `STEP` and `EXCEPTION` and can be easily integrated into your Python projects.
-
-## Installation
-You can install the package using pip:
-```bash
-pip install custom-python-logger
-```
-
-## Usage
-```python
-import logging
-from custom_python_logger.logger import get_logger, CustomLoggerAdapter
-
-logger: CustomLoggerAdapter = CustomLoggerAdapter(logging.getLogger(__name__))
-
-
-def main():
-    logger.debug("This is a debug message.")
-    logger.info("This is an info message.")
-    logger.step("This is a step message.")
-    logger.warning("This is a warning message.")
-
-    try:
-        _ = 1 / 0
-    except ZeroDivisionError:
-        logger.exception("This is an exception message.")
-
-    logger.critical("This is a critical message.")
-
-
-if __name__ == '__main__':
-    _ = get_logger(
-        project_name='Logger Project Test',
-        log_level=logging.DEBUG,
-        extra={'user': 'test_user'}
-    )
-
-    main()
-```
-
----
-
-## 🤝 Contributing
-If you have a helpful tool, pattern, or improvement to suggest:
-Fork the repo <br>
-Create a new branch <br>
-Submit a pull request <br>
-I welcome additions that promote clean, productive, and maintainable development. <br>
-
----
-
-## 🙏 Thanks
-Thanks for exploring this repository! <br>
-Happy coding! <br>

custom_python_logger-1.0.9/custom_python_logger.egg-info/PKG-INFO

@@ -1,83 +0,0 @@
-Metadata-Version: 2.4
-Name: custom-python-logger
-Version: 1.0.9
-Summary: A custom logger with color support and additional features.
-Home-page: https://github.com/aviz92/custom-python-logger
-Author: Avi Zaguri
-Author-email: 
-Project-URL: Repository, https://github.com/aviz92/custom-python-logger
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: setuptools
-Requires-Dist: wheel
-Requires-Dist: colorlog
-Requires-Dist: pytest
-Requires-Dist: pathlib
-Requires-Dist: PyYAML
-Dynamic: author
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license-file
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# Custom Logger
-A Python logger with colored output and additional log levels. <br> 
-The logger supports custom log levels like `STEP` and `EXCEPTION` and can be easily integrated into your Python projects.
-
-## Installation
-You can install the package using pip:
-```bash
-pip install custom-python-logger
-```
-
-## Usage
-```python
-import logging
-from custom_python_logger.logger import get_logger, CustomLoggerAdapter
-
-logger: CustomLoggerAdapter = CustomLoggerAdapter(logging.getLogger(__name__))
-
-
-def main():
-    logger.debug("This is a debug message.")
-    logger.info("This is an info message.")
-    logger.step("This is a step message.")
-    logger.warning("This is a warning message.")
-
-    try:
-        _ = 1 / 0
-    except ZeroDivisionError:
-        logger.exception("This is an exception message.")
-
-    logger.critical("This is a critical message.")
-
-
-if __name__ == '__main__':
-    _ = get_logger(
-        project_name='Logger Project Test',
-        log_level=logging.DEBUG,
-        extra={'user': 'test_user'}
-    )
-
-    main()
-```
-
----
-
-## 🤝 Contributing
-If you have a helpful tool, pattern, or improvement to suggest:
-Fork the repo <br>
-Create a new branch <br>
-Submit a pull request <br>
-I welcome additions that promote clean, productive, and maintainable development. <br>
-
----
-
-## 🙏 Thanks
-Thanks for exploring this repository! <br>
-Happy coding! <br>