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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: devsetgo_lib
-Version: 0.13.0
+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.0 → devsetgo_lib-0.13.2}/dsg_lib/__init__.py

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

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

@@ -1,29 +1,22 @@
 # -*- coding: utf-8 -*-
 """
-This module provides a function to configure and set up a logger using the loguru package.
+This module provides a comprehensive logging setup using the loguru library, facilitating easy logging management for Python applications. The `config_log` function, central to this module, allows for extensive customization of logging behavior. It supports specifying the logging directory, log file name, logging level, and controls for log rotation, retention, and formatting among other features. Additionally, it offers advanced options like backtrace and diagnose for in-depth debugging, and the ability to append the application name to the log file for clearer identification.
 
-The `config_log` function takes several optional parameters to customize the logger's behavior,
-including the logging directory, log name, logging level, log rotation size, log retention period,
-and more. It also provides an option to append the application name to the log file name.
+Usage example:
 
-Example:
 ```python
 from dsg_lib.common_functions.logging_config import config_log
 
 config_log(
-    logging_directory='logs',  # Directory where logs will be stored
-    log_name='log',  # Name of the log file (extension will be added automatically set v0.12.2)
-    logging_level='DEBUG',  # Logging level
-    log_rotation='100 MB',  # Log rotation size
-    log_retention='30 days',  # Log retention period
-    log_backtrace=True,  # Enable backtrace
-    log_format="<green>{time:YYYY-MM-DD HH:mm:ss.SSSSSS}</green> | <level>{level: <8}</level> | <cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>",  # Log format
-    log_serializer=False,  # Disable log serialization
-    log_diagnose=True,  # Enable diagnose
-    app_name='my_app',  # Application name
-    append_app_name=True  # Append application name to the log file name
+    logging_directory='logs',  # Directory for storing logs
+    log_name='log',  # Base name for log files
+    logging_level='DEBUG',  # Minimum logging level
+    log_rotation='100 MB',  # Size threshold for log rotation
+    log_retention='30 days',  # Duration to retain old log files
+    enqueue=True,  # Enqueue log messages
 )
 
+# Example log messages
 logger.debug("This is a debug message")
 logger.info("This is an info message")
 logger.error("This is an error message")
@@ -32,10 +25,12 @@ logger.critical("This is a critical message")
 ```
 
 Author: Mike Ryan
-Date: 2024/05/16
+DateCreated: 2021/07/16
+DateUpdated: 2024/07/24
+
 License: MIT
 """
-
+import time
 import logging
 from pathlib import Path
 from uuid import uuid4
@@ -55,6 +50,9 @@ def config_log(
     log_diagnose: bool = False,
     app_name: str = None,
     append_app_name: bool = False,
+    enqueue: bool = True,
+    intercept_standard_logging: bool = True,
+    file_sink: bool = True,
 ):
     """
     Configures and sets up a logger using the loguru package.
@@ -71,6 +69,9 @@ def config_log(
     - log_diagnose (bool): Whether to enable diagnose. Default is False.
     - app_name (str): The application name. Default is None.
     - append_app_name (bool): Whether to append the application name to the log file name. Default is False.
+    - enqueue (bool): Whether to enqueue log messages. Default is True.
+    - intercept_standard_logging (bool): Whether to intercept standard logging. Default is True.
+    - file_sink (bool): Whether to use a file sink. Default is True.
 
     Raises:
     - ValueError: If the provided logging level is not valid.
@@ -83,14 +84,17 @@ def config_log(
         logging_directory='logs',
         log_name='app.log',
         logging_level='DEBUG',
-        log_rotation='500 MB',
+        log_rotation='100 MB',
         log_retention='10 days',
         log_backtrace=True,
         log_format="<green>{time:YYYY-MM-DD HH:mm:ss.SSSSSS}</green> | <level>{level: <8}</level> | <cyan>{name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>",
         log_serializer=False,
         log_diagnose=True,
         app_name='my_app',
-        append_app_name=True
+        append_app_name=True,
+        enqueue=True,
+        intercept_standard_logging=True,
+        file_sink=True
     )
     ```
     """
@@ -108,6 +112,7 @@ def config_log(
         log_format = '<green>{time:YYYY-MM-DD HH:mm:ss.SSSSSS}</green> | <level>{level: <8}</level> | <cyan> {name}</cyan>:<cyan>{function}</cyan>:<cyan>{line}</cyan> - <level>{message}</level>'  # pragma: no cover
 
     if log_serializer is True:
+        log_format = '{message}'  # pragma: no cover
         log_name = f'{log_name}.json'  # pragma: no cover
     else:
         log_name = f'{log_name}.log'  # pragma: no cover
@@ -140,7 +145,7 @@ def config_log(
         log_path,
         level=logging_level.upper(),
         format=log_format,
-        enqueue=True,
+        enqueue=enqueue,
         backtrace=log_backtrace,
         rotation=log_rotation,
         retention=log_retention,
@@ -149,6 +154,8 @@ def config_log(
         diagnose=log_diagnose,
     )
 
+    basic_config_handlers:list = []
+
     class InterceptHandler(logging.Handler):
         """
         Interceptor for standard logging.
@@ -194,12 +201,70 @@ def config_log(
                 level, record.getMessage()
             )  # pragma: no cover
 
-    # Configure standard logging to use interceptor handler
-    logging.basicConfig(handlers=[InterceptHandler()], level=logging_level.upper())
 
-    # Add interceptor handler to all existing loggers
-    for name in logging.root.manager.loggerDict:
-        logging.getLogger(name).addHandler(InterceptHandler())
+    if intercept_standard_logging:
+        # Add interceptor handler to all existing loggers
+        for name in logging.root.manager.loggerDict:
+            logging.getLogger(name).addHandler(InterceptHandler())
+
+        # Add interceptor handler to the root logger
+        basic_config_handlers.append(InterceptHandler())
 
     # Set the root logger's level to the lowest level possible
     logging.getLogger().setLevel(logging.NOTSET)
+
+
+    class ResilientFileSink:
+        """
+        A file sink designed for resilience, capable of retrying write operations.
+
+        This class implements a resilient file writing mechanism that attempts to write messages to a file, retrying the operation a specified number of times if it fails. This is particularly useful in scenarios where write operations might intermittently fail due to temporary issues such as file system locks or networked file system delays.
+
+        Attributes:
+            path (str): The path to the file where messages will be written.
+            max_retries (int): The maximum number of retry attempts for a failed write operation.
+            retry_delay (float): The delay between retry attempts, in seconds.
+
+        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=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')
+
+        @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:
+                        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:
+                        time.sleep(self.retry_delay)  # Wait before retrying
+                    else:
+                        raise  # Reraise if max retries exceeded
+
+
+    if file_sink:
+        # Create an instance of ResilientFileSink
+        resilient_sink = ResilientFileSink(str(log_path))
+
+        # Configure the logger to use the ResilientFileSink
+        basic_config_handlers.append(resilient_sink)
+
+    if intercept_standard_logging:
+        basic_config_handlers.append(InterceptHandler())
+
+    if len(basic_config_handlers) > 0:
+        logging.basicConfig(handlers=basic_config_handlers, level=logging_level.upper())

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

@@ -8,7 +8,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "devsetgo_lib"
-version = "0.13.0"
+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.
@@ -116,9 +116,9 @@ quote-style = "single"
 
 
 [tool.flake8]
-max-line-length = 132
-max-doc-length = 132
-ignore = ["E302","E501"]
+max-line-length = 100
+max-doc-length = 100
+ignore = ["E302", "E501","E303"]  # Keeping the ignores the same as before since ruff's specific ignores aren't directly transferable
 exclude = [
     ".git",
     "__pycache__",

devsetgo_lib-0.13.0/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/).