devsetgo-lib 0.13.1__tar.gz → 0.13.2__tar.gz

{devsetgo_lib-0.13.1 → devsetgo_lib-0.13.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: devsetgo_lib
-Version: 0.13.1
+Version: 0.13.2
 Summary: DevSetGo Library is a Python library offering reusable functions for efficient coding. It includes file operations, calendar utilities, pattern matching, advanced logging with loguru, FastAPI endpoints, async database handling, and email validation. Designed for ease of use and versatility, it's a valuable tool for Python developers.
 Project-URL: Homepage, https://github.com/devsetgo/devsetgo_lib
 Project-URL: Documentation, https://devsetgo.github.io/devsetgo_lib/
@@ -82,78 +82,60 @@ Support Python Versions
 ![Static Badge](https://img.shields.io/badge/Python-3.12%20%7C%203.11%20%7C%203.10%20%7C%203.9-blue)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
-
 CI/CD Pipeline:
 
 [![Testing - Main](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml)
 [![Testing - Dev](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml/badge.svg?branch=dev)](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml)
-[![Coverage fury.io](coverage-badge.svg)](https://github.com/devsetgo/dsg_lib)
 
 SonarCloud:
 
 [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=coverage)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=alert_status)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
-
 [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
 [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
 
-![Static Badge](https://img.shields.io/badge/Documentation-v0.12.2-blue?link=https%3A%2F%2Fdevsetgo.github.io%2Fdevsetgo_lib)
 
 
 # DevSetGo Common Library
 
-## Introduction
-The DevSetGo Common Library is a comprehensive package of common functions designed to eliminate repetitive coding and enhance code reusability. It aims to save developers time and effort across various projects.
-
-## Compatibility and Testing
-- **Tested on**: Windows, Linux.
-- **Compatibility**: Potentially compatible with MacOS (feedback on issues is appreciated).
-
-## Library Functions
-### Common Functions
-- **File Functions**:
-  - CSV File Functions
-  - JSON File Functions
-  - Text File Functions
-- **Folder Functions**:
-  - Make Directory
-  - Remove Directory
-  - Last File Changed
-  - Directory List
-- **Calendar Functions**:
-  - Get Month
-  - Get Month Number
-- **Patterns**:
-  - Pattern Between Two Characters
+`devsetgo_lib` is a versatile library designed to provide common functions for Python applications. Its main goal is to increase reusability and reduce the need to rewrite the same functions across multiple applications. This also allows for quick defect resolution and propagation of fixes across all dependent projects.
+
+## Key Features
+
+- **File Operations**:
+  - **CSV, JSON, and Text File Functions**: Create, read, write, and manipulate various file types with ease.
+  - **Folder Functions**: Create and remove directories, list directory contents, and manage file system operations efficiently.
+
 - **Logging**:
-  - Logging configuration and interceptor
+  - Comprehensive logging setup using the `loguru` library. Provides extensive customization options for log configuration, including log rotation, retention, and formatting.
+
+- **Calendar Functions**:
+  - Convert between month names and numbers seamlessly.
 
-### FastAPI Endpoints
-- **Systems Health Endpoints**:
-  - Status/Health, Heapdump, Uptime
-- **HTTP Codes**:
-  - Method to generate HTTP response codes
+- **Pattern Matching**:
+  - Powerful tools for searching patterns in text using regular expressions.
 
-### Async Database
-- Database Config
-- Async Session
-- CRUD Operations
+- **FastAPI Endpoints**:
+  - Pre-built endpoints for system health checks, status, and uptime monitoring.
+  - Functions to generate HTTP response codes easily.
 
-## Examples and Usage
-Refer to the [Recipes Pages](https://devsetgo.github.io/devsetgo_lib/recipes/fastapi/)
+- **Async Database**:
+  - Configuration and management of asynchronous database sessions.
+  - CRUD operations with async support.
 
-## Installation Guide
-[Quick Start](https://devsetgo.github.io/devsetgo_lib/quickstart/)
+## Installation
 
-```python
+To install `devsetgo_lib`, use pip:
+
+```sh
 pip install devsetgo-lib
 
-# Aysync database setup
+# For async database setup with SQLite or PostgreSQL
 pip install devsetgo-lib[sqlite]
 pip install devsetgo-lib[postgres]
 
-# Consider these experimental and untested
+# Experimental support for other databases
 pip install devsetgo-lib[oracle]
 pip install devsetgo-lib[mssql]
 pip install devsetgo-lib[mysql]
@@ -165,15 +147,43 @@ pip install devsetgo-lib[fastapi]
 pip install devsetgo-lib[all]
 ```
 
+## Usage
+
+Here's a quick example to demonstrate how you can use some of the key features of `devsetgo_lib`:
+
+```python
+from devsetgo_lib import file_functions, logging_config, patterns, calendar_functions
+
+# File Operations
+file_functions.create_sample_files("example", 100)
+content = file_functions.read_from_file("example.csv")
+print(content)
+
+# Logging
+logging_config.config_log(logging_directory='logs', log_name='app.log', logging_level='DEBUG')
+logger = logging.getLogger('app_logger')
+logger.info("This is an info message")
+
+# Pattern Matching
+text = "Hello, my name is 'John Doe' and I live in 'New York'."
+results = patterns.pattern_between_two_char(text, "'", "'")
+print(results)
+
+# Calendar Functions
+print(calendar_functions.get_month(1))  # Output: 'January'
+print(calendar_functions.get_month_number('January'))  # Output: 1
+```
+
+For detailed documentation on each module and function, please refer to the [official documentation](https://devsetgo.github.io/devsetgo_lib/print_page/).
 
-## Contribution and Feedback
-Contributions and feedback are highly appreciated. Please refer to our [Contribution Guidelines](https://github.com/devsetgo/devsetgo_lib/blob/main/CONTRIBUTING.md).
+## Contributing
+
+We welcome contributions! Please see our [contributing guidelines](CONTRIBUTING.md) for more details.
 
 ## License
-[MIT Licensed](https://github.com/devsetgo/devsetgo_lib/blob/main/LICENSE)
 
-## Author Information
-[Mike Ryan](https://github.com/devsetgo)
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
+
+## Contact
 
-## Further Documentation
-For more detailed information, visit [LINK_TO_DETAILED_DOCUMENTATION](https://devsetgo.github.io/devsetgo_lib/).
+For any questions or issues, please open an issue on GitHub or contact us at [devsetgo@example.com](mailto:devsetgo@example.com).

devsetgo_lib-0.13.2/README.md

@@ -0,0 +1,117 @@
+Python:
+
+[![PyPI version fury.io](https://badge.fury.io/py/devsetgo-lib.svg)](https://pypi.python.org/pypi/devsetgo-lib/)
+[![Downloads](https://static.pepy.tech/badge/devsetgo-lib)](https://pepy.tech/project/devsetgo-lib)
+[![Downloads](https://static.pepy.tech/badge/devsetgo-lib/month)](https://pepy.tech/project/devsetgo-lib)
+[![Downloads](https://static.pepy.tech/badge/devsetgo-lib/week)](https://pepy.tech/project/devsetgo-lib)
+
+Support Python Versions
+
+![Static Badge](https://img.shields.io/badge/Python-3.12%20%7C%203.11%20%7C%203.10%20%7C%203.9-blue)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+CI/CD Pipeline:
+
+[![Testing - Main](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml)
+[![Testing - Dev](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml/badge.svg?branch=dev)](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml)
+
+SonarCloud:
+
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=coverage)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=alert_status)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
+
+
+
+# DevSetGo Common Library
+
+`devsetgo_lib` is a versatile library designed to provide common functions for Python applications. Its main goal is to increase reusability and reduce the need to rewrite the same functions across multiple applications. This also allows for quick defect resolution and propagation of fixes across all dependent projects.
+
+## Key Features
+
+- **File Operations**:
+  - **CSV, JSON, and Text File Functions**: Create, read, write, and manipulate various file types with ease.
+  - **Folder Functions**: Create and remove directories, list directory contents, and manage file system operations efficiently.
+
+- **Logging**:
+  - Comprehensive logging setup using the `loguru` library. Provides extensive customization options for log configuration, including log rotation, retention, and formatting.
+
+- **Calendar Functions**:
+  - Convert between month names and numbers seamlessly.
+
+- **Pattern Matching**:
+  - Powerful tools for searching patterns in text using regular expressions.
+
+- **FastAPI Endpoints**:
+  - Pre-built endpoints for system health checks, status, and uptime monitoring.
+  - Functions to generate HTTP response codes easily.
+
+- **Async Database**:
+  - Configuration and management of asynchronous database sessions.
+  - CRUD operations with async support.
+
+## Installation
+
+To install `devsetgo_lib`, use pip:
+
+```sh
+pip install devsetgo-lib
+
+# For async database setup with SQLite or PostgreSQL
+pip install devsetgo-lib[sqlite]
+pip install devsetgo-lib[postgres]
+
+# Experimental support for other databases
+pip install devsetgo-lib[oracle]
+pip install devsetgo-lib[mssql]
+pip install devsetgo-lib[mysql]
+
+# For adding FastAPI endpoints
+pip install devsetgo-lib[fastapi]
+
+# Install everything
+pip install devsetgo-lib[all]
+```
+
+## Usage
+
+Here's a quick example to demonstrate how you can use some of the key features of `devsetgo_lib`:
+
+```python
+from devsetgo_lib import file_functions, logging_config, patterns, calendar_functions
+
+# File Operations
+file_functions.create_sample_files("example", 100)
+content = file_functions.read_from_file("example.csv")
+print(content)
+
+# Logging
+logging_config.config_log(logging_directory='logs', log_name='app.log', logging_level='DEBUG')
+logger = logging.getLogger('app_logger')
+logger.info("This is an info message")
+
+# Pattern Matching
+text = "Hello, my name is 'John Doe' and I live in 'New York'."
+results = patterns.pattern_between_two_char(text, "'", "'")
+print(results)
+
+# Calendar Functions
+print(calendar_functions.get_month(1))  # Output: 'January'
+print(calendar_functions.get_month_number('January'))  # Output: 1
+```
+
+For detailed documentation on each module and function, please refer to the [official documentation](https://devsetgo.github.io/devsetgo_lib/print_page/).
+
+## Contributing
+
+We welcome contributions! Please see our [contributing guidelines](CONTRIBUTING.md) for more details.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
+
+## Contact
+
+For any questions or issues, please open an issue on GitHub or contact us at [devsetgo@example.com](mailto:devsetgo@example.com).

{devsetgo_lib-0.13.1 → devsetgo_lib-0.13.2}/dsg_lib/__init__.py

@@ -1,3 +1,3 @@
 # -*- coding: utf-8 -*-
 
-__version__ = '0.13.1'
+__version__ = '0.13.2'

{devsetgo_lib-0.13.1 → devsetgo_lib-0.13.2}/dsg_lib/common_functions/logging_config.py

@@ -228,16 +228,26 @@ def config_log(
         Methods:
             write(message): Attempts to write a message to the file, retrying on failure up to `max_retries` times.
         """
-        def __init__(self, path, max_retries=5, retry_delay=0.1):
+        def __init__(self, path, max_retries=3, retry_delay=1.0, formatter=None):
             self.path = path
             self.max_retries = max_retries
             self.retry_delay = retry_delay
+            self._formatter = formatter or logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s')
 
-        def write(self, message): # pragma: no cover
+        @property
+        def formatter(self):
+            return self._formatter
+
+        @formatter.setter
+        def formatter(self, value):
+            self._formatter = value
+
+        def write(self, message):
             for attempt in range(self.max_retries):
                 try:
                     with open(self.path, 'a') as file:
-                        file.write(str(message))
+                        formatted_message = self.formatter.format(message) if self._formatter else message
+                        file.write(formatted_message + '\n')  # Ensure newline
                     break  # Successfully written, break the loop
                 except FileNotFoundError:
                     if attempt < self.max_retries - 1:

{devsetgo_lib-0.13.1 → devsetgo_lib-0.13.2}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "devsetgo_lib"
-version = "0.13.1"
+version = "0.13.2"
 requires-python = ">=3.9"
 description = """
 DevSetGo Library is a Python library offering reusable functions for efficient coding. It includes file operations, calendar utilities, pattern matching, advanced logging with loguru, FastAPI endpoints, async database handling, and email validation. Designed for ease of use and versatility, it's a valuable tool for Python developers.

devsetgo_lib-0.13.1/README.md

@@ -1,107 +0,0 @@
-Python:
-
-[![PyPI version fury.io](https://badge.fury.io/py/devsetgo-lib.svg)](https://pypi.python.org/pypi/devsetgo-lib/)
-[![Downloads](https://static.pepy.tech/badge/devsetgo-lib)](https://pepy.tech/project/devsetgo-lib)
-[![Downloads](https://static.pepy.tech/badge/devsetgo-lib/month)](https://pepy.tech/project/devsetgo-lib)
-[![Downloads](https://static.pepy.tech/badge/devsetgo-lib/week)](https://pepy.tech/project/devsetgo-lib)
-
-Support Python Versions
-
-![Static Badge](https://img.shields.io/badge/Python-3.12%20%7C%203.11%20%7C%203.10%20%7C%203.9-blue)
-[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
-
-
-CI/CD Pipeline:
-
-[![Testing - Main](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml/badge.svg?branch=main)](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml)
-[![Testing - Dev](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml/badge.svg?branch=dev)](https://github.com/devsetgo/devsetgo_lib/actions/workflows/testing.yml)
-[![Coverage fury.io](coverage-badge.svg)](https://github.com/devsetgo/dsg_lib)
-
-SonarCloud:
-
-[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=coverage)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
-[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=alert_status)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
-
-[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
-[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=devsetgo_devsetgo_lib&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=devsetgo_devsetgo_lib)
-
-![Static Badge](https://img.shields.io/badge/Documentation-v0.12.2-blue?link=https%3A%2F%2Fdevsetgo.github.io%2Fdevsetgo_lib)
-
-
-# DevSetGo Common Library
-
-## Introduction
-The DevSetGo Common Library is a comprehensive package of common functions designed to eliminate repetitive coding and enhance code reusability. It aims to save developers time and effort across various projects.
-
-## Compatibility and Testing
-- **Tested on**: Windows, Linux.
-- **Compatibility**: Potentially compatible with MacOS (feedback on issues is appreciated).
-
-## Library Functions
-### Common Functions
-- **File Functions**:
-  - CSV File Functions
-  - JSON File Functions
-  - Text File Functions
-- **Folder Functions**:
-  - Make Directory
-  - Remove Directory
-  - Last File Changed
-  - Directory List
-- **Calendar Functions**:
-  - Get Month
-  - Get Month Number
-- **Patterns**:
-  - Pattern Between Two Characters
-- **Logging**:
-  - Logging configuration and interceptor
-
-### FastAPI Endpoints
-- **Systems Health Endpoints**:
-  - Status/Health, Heapdump, Uptime
-- **HTTP Codes**:
-  - Method to generate HTTP response codes
-
-### Async Database
-- Database Config
-- Async Session
-- CRUD Operations
-
-## Examples and Usage
-Refer to the [Recipes Pages](https://devsetgo.github.io/devsetgo_lib/recipes/fastapi/)
-
-## Installation Guide
-[Quick Start](https://devsetgo.github.io/devsetgo_lib/quickstart/)
-
-```python
-pip install devsetgo-lib
-
-# Aysync database setup
-pip install devsetgo-lib[sqlite]
-pip install devsetgo-lib[postgres]
-
-# Consider these experimental and untested
-pip install devsetgo-lib[oracle]
-pip install devsetgo-lib[mssql]
-pip install devsetgo-lib[mysql]
-
-# For adding FastAPI endpoints
-pip install devsetgo-lib[fastapi]
-
-# Install everything
-pip install devsetgo-lib[all]
-```
-
-
-## Contribution and Feedback
-Contributions and feedback are highly appreciated. Please refer to our [Contribution Guidelines](https://github.com/devsetgo/devsetgo_lib/blob/main/CONTRIBUTING.md).
-
-## License
-[MIT Licensed](https://github.com/devsetgo/devsetgo_lib/blob/main/LICENSE)
-
-## Author Information
-[Mike Ryan](https://github.com/devsetgo)
-
-## Further Documentation
-For more detailed information, visit [LINK_TO_DETAILED_DOCUMENTATION](https://devsetgo.github.io/devsetgo_lib/).