pythonLogs 4.0.2__tar.gz → 4.0.3__tar.gz

{pythonlogs-4.0.2 → pythonlogs-4.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: pythonLogs
-Version: 4.0.2
+Version: 4.0.3
 Summary: High-performance Python logging library with file rotation and optimized caching for better performance
 License: MIT
 Keywords: python3,python-3,python,log,logging,logger,logutils,log-utils,pythonLogs
@@ -54,11 +54,15 @@ High-performance Python logging library with file rotation and optimized caching
   - [Timed Rotating Logger](#timed-rotating-logger)
 - [Context Manager Support](#context-manager-support)
 - [Advanced Factory Features](#advanced-factory-features)
+- [Environment Variables](#env-variables-optional--production)
 - [Memory Management](#memory-management)
+- [Flexible Configuration Options](#flexible-configuration-options)
 - [Migration Guide](#migration-guide)
 - [Performance Improvements](#performance-improvements)
-- [Environment Variables](#env-variables-optional)
 - [Development](#source-code)
+- [Run Tests and Get Coverage Report using Poe](#run-tests-and-get-coverage-report-using-poe)
+- [License](#license)
+- [Buy me a cup of coffee](#buy-me-a-cup-of-coffee)
 
 
 
@@ -264,6 +268,7 @@ logger.warning("This is a warning example")
 
 # Context Manager Support
 
+Slow, but if you want immediate, deterministic cleanup for a specific scope.\
 All logger types support context managers for automatic resource cleanup and exception safety:
 
 ## Basic Usage
@@ -333,44 +338,6 @@ assert logger1 is logger2
 clear_logger_registry()
 ```
 
-## Flexible Configuration Options
-You can use either enums (for type safety) or strings (for simplicity):
-
-```python
-from pythonLogs import LogLevel, RotateWhen, LoggerType
-
-# Option 1: Type-safe enums (recommended)
-LogLevel.DEBUG     # "DEBUG"
-LogLevel.INFO      # "INFO"  
-LogLevel.WARNING   # "WARNING"
-LogLevel.ERROR     # "ERROR"
-LogLevel.CRITICAL  # "CRITICAL"
-
-# Option 2: String values (case-insensitive)
-"debug"       # Same as LogLevel.DEBUG
-"info"        # Same as LogLevel.INFO
-"warning"     # Same as LogLevel.WARNING  
-"warn"        # Same as LogLevel.WARN (alias)
-"error"       # Same as LogLevel.ERROR
-"critical"    # Same as LogLevel.CRITICAL
-"crit"        # Same as LogLevel.CRIT (alias)
-# Also supports: "DEBUG", "Info", "Warning", etc.
-
-# RotateWhen values
-RotateWhen.MIDNIGHT   # "midnight"
-RotateWhen.HOURLY     # "H"
-RotateWhen.DAILY      # "D"
-RotateWhen.MONDAY     # "W0"
-# ... through SUNDAY  # "W6"
-# String equivalents: "midnight", "H", "D", "W0"-"W6"
-
-# LoggerType values
-LoggerType.BASIC            # "basic"
-LoggerType.SIZE_ROTATING    # "size_rotating"  
-LoggerType.TIMED_ROTATING   # "timed_rotating"
-# String equivalents: "basic", "size_rotating", "timed_rotating"
-```
-
 ## Production Setup Example
 ```python
 from pythonLogs import size_rotating_logger, timed_rotating_logger, LogLevel, RotateWhen
@@ -415,9 +382,9 @@ audit_logger.info("User admin logged in")
 ```
 
 ## Env Variables (Optional | Production)
-.env variables can be used by leaving all options blank when calling the function
-If not specified inside the .env file, it will use the dafault value
-This is a good approach for production environments, since options can be changed easily
+The .env variables file can be used by leaving all options blank when calling the function.\
+If not specified inside the .env file, it will use the dafault value.\
+This is a good approach for production environments, since options can be changed easily.
 ```python
 from pythonLogs import timed_rotating_logger
 log = timed_rotating_logger()
@@ -447,8 +414,6 @@ LOG_ROTATE_FILE_SUFIX="%Y%m%d"
 ```
 
 
-
-
 # Memory Management
 
 The library includes comprehensive memory management features to prevent memory leaks and optimize resource usage:
@@ -545,6 +510,45 @@ clear_logger_registry()
 ```
 
 
+# Flexible Configuration Options
+You can use either enums (for type safety) or strings (for simplicity):
+
+```python
+from pythonLogs import LogLevel, RotateWhen, LoggerType
+
+# Option 1: Type-safe enums (recommended)
+LogLevel.DEBUG     # "DEBUG"
+LogLevel.INFO      # "INFO"  
+LogLevel.WARNING   # "WARNING"
+LogLevel.ERROR     # "ERROR"
+LogLevel.CRITICAL  # "CRITICAL"
+
+# Option 2: String values (case-insensitive)
+"debug"       # Same as LogLevel.DEBUG
+"info"        # Same as LogLevel.INFO
+"warning"     # Same as LogLevel.WARNING  
+"warn"        # Same as LogLevel.WARN (alias)
+"error"       # Same as LogLevel.ERROR
+"critical"    # Same as LogLevel.CRITICAL
+"crit"        # Same as LogLevel.CRIT (alias)
+# Also supports: "DEBUG", "Info", "Warning", etc.
+
+# RotateWhen values
+RotateWhen.MIDNIGHT   # "midnight"
+RotateWhen.HOURLY     # "H"
+RotateWhen.DAILY      # "D"
+RotateWhen.MONDAY     # "W0"
+# ... through SUNDAY  # "W6"
+# String equivalents: "midnight", "H", "D", "W0"-"W6"
+
+# LoggerType values
+LoggerType.BASIC            # "basic"
+LoggerType.SIZE_ROTATING    # "size_rotating"  
+LoggerType.TIMED_ROTATING   # "timed_rotating"
+# String equivalents: "basic", "size_rotating", "timed_rotating"
+```
+
+
 # Migration Guide
 
 ## Upgrading from Legacy to Factory Pattern

{pythonlogs-4.0.2 → pythonlogs-4.0.3}/README.md

@@ -24,11 +24,15 @@ High-performance Python logging library with file rotation and optimized caching
   - [Timed Rotating Logger](#timed-rotating-logger)
 - [Context Manager Support](#context-manager-support)
 - [Advanced Factory Features](#advanced-factory-features)
+- [Environment Variables](#env-variables-optional--production)
 - [Memory Management](#memory-management)
+- [Flexible Configuration Options](#flexible-configuration-options)
 - [Migration Guide](#migration-guide)
 - [Performance Improvements](#performance-improvements)
-- [Environment Variables](#env-variables-optional)
 - [Development](#source-code)
+- [Run Tests and Get Coverage Report using Poe](#run-tests-and-get-coverage-report-using-poe)
+- [License](#license)
+- [Buy me a cup of coffee](#buy-me-a-cup-of-coffee)
 
 
 
@@ -234,6 +238,7 @@ logger.warning("This is a warning example")
 
 # Context Manager Support
 
+Slow, but if you want immediate, deterministic cleanup for a specific scope.\
 All logger types support context managers for automatic resource cleanup and exception safety:
 
 ## Basic Usage
@@ -303,44 +308,6 @@ assert logger1 is logger2
 clear_logger_registry()
 ```
 
-## Flexible Configuration Options
-You can use either enums (for type safety) or strings (for simplicity):
-
-```python
-from pythonLogs import LogLevel, RotateWhen, LoggerType
-
-# Option 1: Type-safe enums (recommended)
-LogLevel.DEBUG     # "DEBUG"
-LogLevel.INFO      # "INFO"  
-LogLevel.WARNING   # "WARNING"
-LogLevel.ERROR     # "ERROR"
-LogLevel.CRITICAL  # "CRITICAL"
-
-# Option 2: String values (case-insensitive)
-"debug"       # Same as LogLevel.DEBUG
-"info"        # Same as LogLevel.INFO
-"warning"     # Same as LogLevel.WARNING  
-"warn"        # Same as LogLevel.WARN (alias)
-"error"       # Same as LogLevel.ERROR
-"critical"    # Same as LogLevel.CRITICAL
-"crit"        # Same as LogLevel.CRIT (alias)
-# Also supports: "DEBUG", "Info", "Warning", etc.
-
-# RotateWhen values
-RotateWhen.MIDNIGHT   # "midnight"
-RotateWhen.HOURLY     # "H"
-RotateWhen.DAILY      # "D"
-RotateWhen.MONDAY     # "W0"
-# ... through SUNDAY  # "W6"
-# String equivalents: "midnight", "H", "D", "W0"-"W6"
-
-# LoggerType values
-LoggerType.BASIC            # "basic"
-LoggerType.SIZE_ROTATING    # "size_rotating"  
-LoggerType.TIMED_ROTATING   # "timed_rotating"
-# String equivalents: "basic", "size_rotating", "timed_rotating"
-```
-
 ## Production Setup Example
 ```python
 from pythonLogs import size_rotating_logger, timed_rotating_logger, LogLevel, RotateWhen
@@ -385,9 +352,9 @@ audit_logger.info("User admin logged in")
 ```
 
 ## Env Variables (Optional | Production)
-.env variables can be used by leaving all options blank when calling the function
-If not specified inside the .env file, it will use the dafault value
-This is a good approach for production environments, since options can be changed easily
+The .env variables file can be used by leaving all options blank when calling the function.\
+If not specified inside the .env file, it will use the dafault value.\
+This is a good approach for production environments, since options can be changed easily.
 ```python
 from pythonLogs import timed_rotating_logger
 log = timed_rotating_logger()
@@ -417,8 +384,6 @@ LOG_ROTATE_FILE_SUFIX="%Y%m%d"
 ```
 
 
-
-
 # Memory Management
 
 The library includes comprehensive memory management features to prevent memory leaks and optimize resource usage:
@@ -515,6 +480,45 @@ clear_logger_registry()
 ```
 
 
+# Flexible Configuration Options
+You can use either enums (for type safety) or strings (for simplicity):
+
+```python
+from pythonLogs import LogLevel, RotateWhen, LoggerType
+
+# Option 1: Type-safe enums (recommended)
+LogLevel.DEBUG     # "DEBUG"
+LogLevel.INFO      # "INFO"  
+LogLevel.WARNING   # "WARNING"
+LogLevel.ERROR     # "ERROR"
+LogLevel.CRITICAL  # "CRITICAL"
+
+# Option 2: String values (case-insensitive)
+"debug"       # Same as LogLevel.DEBUG
+"info"        # Same as LogLevel.INFO
+"warning"     # Same as LogLevel.WARNING  
+"warn"        # Same as LogLevel.WARN (alias)
+"error"       # Same as LogLevel.ERROR
+"critical"    # Same as LogLevel.CRITICAL
+"crit"        # Same as LogLevel.CRIT (alias)
+# Also supports: "DEBUG", "Info", "Warning", etc.
+
+# RotateWhen values
+RotateWhen.MIDNIGHT   # "midnight"
+RotateWhen.HOURLY     # "H"
+RotateWhen.DAILY      # "D"
+RotateWhen.MONDAY     # "W0"
+# ... through SUNDAY  # "W6"
+# String equivalents: "midnight", "H", "D", "W0"-"W6"
+
+# LoggerType values
+LoggerType.BASIC            # "basic"
+LoggerType.SIZE_ROTATING    # "size_rotating"  
+LoggerType.TIMED_ROTATING   # "timed_rotating"
+# String equivalents: "basic", "size_rotating", "timed_rotating"
+```
+
+
 # Migration Guide
 
 ## Upgrading from Legacy to Factory Pattern

{pythonlogs-4.0.2 → pythonlogs-4.0.3}/pyproject.toml

@@ -2,10 +2,9 @@
 requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"
 
-
 [tool.poetry]
 name = "pythonLogs"
-version = "4.0.2"
+version = "4.0.3"
 description = "High-performance Python logging library with file rotation and optimized caching for better performance"
 license = "MIT"
 readme = "README.md"
@@ -31,51 +30,43 @@ classifiers = [
     "Natural Language :: English",
 ]
 
-
 [tool.poetry.dependencies]
 python = "^3.10"
 pydantic = "^2.11.7"
 pydantic-settings = "^2.10.1"
 python-dotenv = "^1.1.1"
 
-
 [tool.poetry.group.test.dependencies]
 coverage = "^7.9.2"
 poethepoet = "^0.36.0"
 psutil = "^7.0.0"
 pytest = "^8.4.1"
 
+[tool.poe.tasks]
+_test = "coverage run -m pytest -v"
+_coverage_report = "coverage report"
+_coverage_xml = "coverage xml"
+tests = ["_test", "_coverage_report", "_coverage_xml"]
+test = ["tests"]
 
 [tool.poetry.group.test]
 optional = true
 
-
 [tool.black]
 line-length = 120
 skip-string-normalization = true
 
-
 [tool.pytest.ini_options]
 markers = [
     "slow: marks tests as slow (deselect with '-m \"not slow\"')"
 ]
 
-
 [tool.coverage.run]
 omit = [
     "tests/*",
 ]
 
-
 [tool.coverage.report]
 exclude_lines = [
     "pragma: no cover",
 ]
-
-
-[tool.poe.tasks]
-_test = "coverage run -m pytest -v"
-_coverage_report = "coverage report"
-_coverage_xml = "coverage xml"
-tests = ["_test", "_coverage_report", "_coverage_xml"]
-test = ["tests"]