devsetgo-lib 0.12.2__tar.gz → 0.12.4__tar.gz

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: devsetgo_lib
-Version: 0.12.2
+Version: 0.12.4
 Summary: DevSetGo Common Library provides reusable Python functions for enhanced code efficiency. It includes utilities for file operations, calendar, pattern matching, logging, FastAPI endpoints, and async database handling with CRUD operations.
 Project-URL: Homepage, https://github.com/devsetgo/devsetgo_lib
 Project-URL: Documentation, https://devsetgo.github.io/devsetgo_lib/
@@ -41,6 +41,7 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Requires-Python: >=3.9
+Requires-Dist: email-validator>=2.1.1
 Requires-Dist: loguru>=0.7.0
 Requires-Dist: packaging>=20.0
 Provides-Extra: all
@@ -71,17 +72,21 @@ Description-Content-Type: text/markdown
 Python:
 
 [![PyPI version fury.io](https://badge.fury.io/py/devsetgo-lib.svg)](https://pypi.python.org/pypi/devsetgo-lib/)
-<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
+[![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)
 
-[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-390/)
-[![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
-[![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110/)
-[![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/downloads/release/python-3120/)
 
 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:
 
@@ -92,6 +97,9 @@ SonarCloud:
 [![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

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/README.md

@@ -1,17 +1,21 @@
 Python:
 
 [![PyPI version fury.io](https://badge.fury.io/py/devsetgo-lib.svg)](https://pypi.python.org/pypi/devsetgo-lib/)
-<a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
+[![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)
 
-[![Python 3.9](https://img.shields.io/badge/python-3.9-blue.svg)](https://www.python.org/downloads/release/python-390/)
-[![Python 3.10](https://img.shields.io/badge/python-3.10-blue.svg)](https://www.python.org/downloads/release/python-3100/)
-[![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110/)
-[![Python 3.12](https://img.shields.io/badge/python-3.12-blue.svg)](https://www.python.org/downloads/release/python-3120/)
 
 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:
 
@@ -22,6 +26,9 @@ SonarCloud:
 [![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

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/__init__.py

@@ -1,3 +1,3 @@
 # -*- coding: utf-8 -*-
 
-__version__ = '0.12.2'
+__version__ = '0.12.4'

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/async_database_functions/__import_sqlalchemy.py

@@ -36,6 +36,9 @@ def import_sqlalchemy() -> Tuple:
     Raises:
         ImportError: If the SQLAlchemy version is less than the minimum required version.
 
+    Author: Mike Ryan
+    Date: 2024/05/16
+    License: MIT
     """
     min_version = '2.0.0'  # Minimum required version of SQLAlchemy
 

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/async_database_functions/async_database.py

@@ -43,6 +43,10 @@ async_db = async_database.AsyncDatabase(db_config)
 # Create a DatabaseOperations instance
 db_ops = database_operations.DatabaseOperations(async_db)
 ```
+
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
 """
 
 

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/async_database_functions/base_schema.py

@@ -25,6 +25,10 @@ class MyModel(base_schema.SchemaBaseSQLite):
         # Define your model-specific columns here my_column =
         base_schema.Column(base_schema.String(50))
 ```
+
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
 """
 # TODO: change datetime.datetime.now(datetime.timezone.utc) to \
 # datetime.datetime.now(datetime.UTC) once only 3.11+ is supported

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/async_database_functions/database_config.py

@@ -38,6 +38,10 @@ from dsg_lib.async_database_functions import database_config
 db_config.get_db_session() as session:
     # Perform your database operations here pass
 ```
+
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
 """
 from contextlib import asynccontextmanager
 from typing import Dict

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/async_database_functions/database_operations.py

@@ -19,6 +19,10 @@ The methods include:
 Each method is tested to ensure it performs the expected operation and handles errors correctly. The tests use the pytest-asyncio plugin to run the asynchronous methods in an event loop, and the unittest.mock library to mock the database session and simulate errors.
 
 The tests are organized into a single class, TestDatabaseOperations, which contains one test method for each method in the DatabaseOperations class. Each test method follows the Arrange-Act-Assert pattern: it sets up the necessary objects and state (Arrange), calls the method being tested (Act), and checks that the results are as expected (Assert).
+
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
 """
 
 import time
@@ -29,7 +33,6 @@ from sqlalchemy import delete
 from sqlalchemy.ext.declarative import DeclarativeMeta
 
 from .__import_sqlalchemy import import_sqlalchemy
-
 # Importing AsyncDatabase class from local module async_database
 from .async_database import AsyncDatabase
 
@@ -793,7 +796,7 @@ class DatabaseOperations:
                 records = result.scalars().all()
                 logger.debug(f'read_query result: {records}')
                 # Log the successful query execution
-                if all(isinstance(record, tuple) for record in records):
+                if all(isinstance(record, tuple) for record in records): #pragma: no cover
                     logger.debug(f'read_query result is a tuple {type(records)}')
                     # If all records are tuples, convert them to dictionaries
                     records_data = [
@@ -1145,7 +1148,7 @@ class DatabaseOperations:
         print(f"Deleted {deleted_count} records.")
         ```
         """
-        if id_values is None:
+        if id_values is None: #pragma: no cover
             id_values = []
         try:
             # Start a timer to measure the operation time

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/common_functions/calendar_functions.py

@@ -45,6 +45,10 @@ print(get_month_number('January'))
 
 This module is part of the dsg_lib package and is used for handling and
 converting between month numbers and names.
+
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
 """
 from loguru import logger
 

devsetgo_lib-0.12.4/dsg_lib/common_functions/email_validation.py

@@ -0,0 +1,276 @@
+# -*- coding: utf-8 -*-
+"""
+This module provides functionality for validating email addresses.
+
+The main function in this module is `validate_email_address`, which takes an email address and a set of optional parameters to control the validation process. It uses the `email_validator` library to perform the validation and returns a dictionary containing the validation result and other information about the email address.
+
+The module also defines a `DNSType` enum for specifying the type of DNS resolver to use during the validation process.
+
+The `validate_email_address` function supports the following optional parameters:
+- `check_deliverability`: If True, the function checks whether the email address is deliverable.
+- `test_environment`: If True, the function operates in test mode and does not actually send any emails.
+- `allow_smtputf8`: If True, the function allows non-ASCII characters in the email address.
+- `allow_empty_local`: If True, the function allows email addresses with an empty local part.
+- `allow_quoted_local`: If True, the function allows email addresses with a quoted local part.
+- `allow_display_name`: If True, the function allows email addresses with a display name.
+- `allow_domain_literal`: If True, the function allows email addresses with a domain literal.
+- `globally_deliverable`: If True, the function checks whether the email address is globally deliverable.
+- `timeout`: The timeout for the DNS resolver, in seconds.
+- `dns_type`: The type of DNS resolver to use, either 'dns' or 'timeout'.
+
+Example:
+    To use the `validate_email` function in this module, you can do the following:
+
+    ```python
+    from email_validation import validate_email
+
+    email = "test@example.com"
+    if validate_email(email):
+        print(f"{email} is valid.")
+    else:
+        print(f"{email} is not valid.")
+    ```
+See example for more use or bottom of module for more use examples.
+
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
+"""
+from enum import Enum
+from typing import Dict, List, Union
+from loguru import logger
+from email_validator import (
+    EmailNotValidError,
+    EmailUndeliverableError,
+    caching_resolver,
+    validate_email,
+)
+
+
+class DNSType(Enum):
+    """
+    Enum representing the type of DNS resolver to use during email validation.
+
+    This enum is used in the `validate_email_address` function to specify the type of DNS resolver to use when checking the deliverability of an email address. The `DNS` option uses a standard DNS resolver, while the `TIMEOUT` option uses a DNS resolver with a specified timeout.
+
+    Attributes:
+        DNS (str): Represents a standard DNS resolver.
+        TIMEOUT (str): Represents a DNS resolver with a specified timeout.
+    """
+    DNS = "dns"
+    TIMEOUT = "timeout"
+
+
+def validate_email_address(
+    email: str,
+    check_deliverability: bool = True,
+    test_environment: bool = False,
+    allow_smtputf8: bool = False,
+    allow_empty_local: bool = False,
+    allow_quoted_local:bool=False,
+    allow_display_name: bool = False,
+    allow_domain_literal: bool = False,
+    globally_deliverable: bool = None,
+    timeout: int = 10,
+    dns_type: str = 'dns',
+) -> Dict[str, Union[str, bool, Dict[str, Union[str, bool, List[str]]]]]:
+    """
+    Validates an email address and returns a dictionary with the validation result and other information.
+
+    This function uses the `email_validator` library to validate the email address. It supports a variety of optional parameters to control the validation process, such as whether to check deliverability, whether to allow non-ASCII characters, and the type of DNS resolver to use.
+
+    Args:
+        email (str): The email address to validate.
+        check_deliverability (bool, optional): If True, checks whether the email address is deliverable. Defaults to True.
+        test_environment (bool, optional): If True, operates in test mode and does not actually send any emails. Defaults to False.
+        allow_smtputf8 (bool, optional): If True, allows non-ASCII characters in the email address. Defaults to False.
+        allow_empty_local (bool, optional): If True, allows email addresses with an empty local part. Defaults to False.
+        allow_quoted_local (bool, optional): If True, allows email addresses with a quoted local part. Defaults to False.
+        allow_display_name (bool, optional): If True, allows email addresses with a display name. Defaults to False.
+        allow_domain_literal (bool, optional): If True, allows email addresses with a domain literal. Defaults to False.
+        globally_deliverable (bool, optional): If True, checks whether the email address is globally deliverable. Defaults to None.
+        timeout (int, optional): The timeout for the DNS resolver, in seconds. Defaults to 10.
+        dns_type (str, optional): The type of DNS resolver to use, either 'dns' or 'timeout'. Defaults to 'dns'.
+
+    Returns:
+        Dict[str, Union[str, bool, Dict[str, Union[str, bool, List[str]]]]]: A dictionary containing the validation result and other information about the email address.
+
+    Raises:
+        ValueError: If `dns_type` is not 'dns' or 'timeout'.
+        EmailUndeliverableError: If the email address is not deliverable.
+        EmailNotValidError: If the email address is not valid according to the `email_validator` library.
+        Exception: If any other error occurs during the validation process.
+    """
+    # Log the function call with the provided parameters
+    logger.debug(f"validate_email_address: {email} with params: {locals()}")
+
+    # Initialize the valid flag to False
+    valid: bool = False
+
+    # Convert the dns_type to a DNSType enum
+    try:
+        dns_type = DNSType(dns_type.lower())
+    except ValueError:
+        raise ValueError("dns_type must be either 'dns' or 'timeout'. Default is 'dns' if not provided or input is None.")
+
+    # Set up the DNS resolver based on the dns_type
+    if dns_type == DNSType.DNS:
+        dns_resolver = caching_resolver(timeout=timeout)
+        dns_param = {"dns_resolver": dns_resolver}
+    elif dns_type == DNSType.TIMEOUT:
+        if timeout is None or timeout <= 0 or isinstance(timeout, int) is False:
+            timeout = 5
+        dns_param = {"timeout": timeout}
+
+    # Validate the email address
+    try:
+        emailinfo = validate_email(
+            email,
+            check_deliverability=check_deliverability,
+            test_environment=test_environment,
+            allow_smtputf8=allow_smtputf8,
+            allow_empty_local=allow_empty_local,
+            allow_domain_literal=allow_domain_literal,
+            globally_deliverable=globally_deliverable,
+            **dns_param,
+        )
+
+        # Normalize the email address
+        email: str = emailinfo.normalized
+
+        # Initialize the return dictionary
+        email_dict: Dict[
+            str, Union[str, bool, Dict[str, Union[str, bool, List[str]]]]
+        ] = {
+            "email": email,
+            "valid": valid,
+            "email_data": None,
+        }
+
+        # Check the deliverability of the email address
+        if not check_deliverability or emailinfo.mx is not None:
+            email_dict["valid"] = True
+            logger.info(f"Email is valid: {email}")
+        else:  # pragma: no cover
+            email_dict["valid"] = False
+            logger.info(f"Email invalid: {email}")
+
+        # Add the email info and parameters to the return dictionary
+        email_dict["email_data"] = dict(sorted(vars(emailinfo).items()))
+        email_dict["parameters"]=dict(sorted(locals().items()))
+
+        # Print and return the dictionary
+        print(email_dict)
+        return email_dict
+
+    # Handle EmailUndeliverableError
+    except EmailUndeliverableError as e:
+        error =  str(e)
+        parameters=dict(sorted(locals().items()))
+        email_dict = {"valid": False, "email": email, "error": error,"error_type": "EmailUndeliverableError","parameters":parameters}
+        logger.error(f"EmailUndeliverableError: {email} - {str(e)}")
+        logger.debug(f"EmailUndeliverableError: {email} - {str(e)}, - {parameters}")
+        return email_dict
+
+    # Handle EmailNotValidError
+    except EmailNotValidError as e:
+        error =  str(e)
+        parameters=dict(sorted(locals().items()))
+        email_dict = {"valid": False, "email": email, "error": error,"error_type": "EmailNotValidError","parameters":parameters}
+        logger.error(f"EmailNotValidError: {email} - {str(e)}")
+        logger.debug(f"EmailNotValidError: {email} - {str(e)}, - {parameters}")
+        return email_dict
+
+    # Handle other exceptions
+    except Exception as e: # pragma: no cover
+        error =  str(e)
+        parameters=dict(sorted(locals().items()))
+        email_dict = {"valid": False, "email": email, "error": error,"error_type": "Exception","parameters":parameters}
+        logger.error(f"Exception: {email} - {str(e)}")
+        logger.debug(f"Exception: {email} - {str(e)}, - {parameters}")
+        return email_dict
+
+
+if __name__ == "__main__":
+    # create a list of email addresses to check if valid
+    email_addresses = [
+        "bob@devsetgo.com",
+        "bob@devset.go",
+        "foo@yahoo.com",
+        "bob@gmail.com",
+        "very fake@devsetgo.com",
+        "jane.doe@example.com",
+        "john_doe@example.co.uk",
+        "user.name+tag+sorting@example.com",
+        "x@example.com",  # shortest possible email address
+        "example-indeed@strange-example.com",
+        "admin@mailserver1",  # local domain name with no TLD
+        "example@s.example",  # see the list of Internet top-level domains
+        '" "@example.org',  # space between the quotes
+        '"john..doe"@example.org',  # quoted double dot
+        "mailhost!username@example.org",  # bangified host route used for uucp mailers
+        "user%example.com@example.org",  # percent sign in local part
+        "user-@example.org",  # valid due to the last character being an allowed character
+        # Invalid email addresses
+        "Abc.example.com",  # no @ character
+        "A@b@c@example.com",  # only one @ is allowed outside quotation marks
+        'a"b(c)d,e:f;g<h>i[j\\k]l@example.com',  # none of the special characters in this local part are allowed outside quotation marks
+        'just"not"right@example.com',  # quoted strings must be dot separated or the only element making up the local-part
+        'this is"not\\allowed@example.com',  # spaces, quotes, and backslashes may only exist when within quoted strings and preceded by a backslash
+        'this\\ still\\"not\\\\allowed@example.com',  # even if escaped (preceded by a backslash), spaces, quotes, and backslashes must still be contained by quotes
+        "1234567890123456789012345678901234567890123456789012345678901234+x@example.com",  # local part is longer than 64 characters
+
+        # Emails with empty local part
+        "@example.com",  # only valid if allow_empty_local is True
+
+        # Emails with non-ASCII characters
+        "üñîçøðé@example.com",  # only valid if allow_smtputf8 is True
+        "user@üñîçøðé.com",  # only valid if allow_smtputf8 is True
+
+        # Emails with quoted local part
+        '"john.doe"@example.com',  # only valid if allow_quoted_local is True
+        '"john..doe"@example.com',  # only valid if allow_quoted_local is True
+
+        # Emails with display name
+        'John Doe <john@example.com>',  # only valid if allow_display_name is True
+
+        # Emails with domain literal
+        'user@[192.0.2.1]',  # only valid if allow_domain_literal is True
+
+        # Emails with long local part
+        "a"*65 + "@example.com",  # local part is longer than 64 characters
+
+        # Emails with invalid characters
+        "john doe@example.com",  # space is not allowed
+        "john@doe@example.com",  # only one @ is allowed
+        "john.doe@.com",  # domain can't start with a dot
+        "john.doe@example..com",  # domain can't have two consecutive dots
+        "test@google.com",
+    ]
+
+    # create a list of configurations
+    configurations = [
+        {"check_deliverability": True, "test_environment": False, "allow_smtputf8": False, "allow_empty_local": False, "allow_quoted_local": False, "allow_display_name": False, "allow_domain_literal": False, "globally_deliverable": None, "timeout": 10, "dns_type": 'timeout'},
+        {"check_deliverability": False, "test_environment": True, "allow_smtputf8": True, "allow_empty_local": True, "allow_quoted_local": True, "allow_display_name": True, "allow_domain_literal": True, "globally_deliverable": None, "timeout": 5, "dns_type": 'dns'},
+        {"check_deliverability": True},
+        # add more configurations here
+    ]
+
+    import pprint
+    import time
+
+    t0 = time.time()
+    validity=[]
+
+    for email in email_addresses:
+        for config in configurations:
+
+            res = validate_email_address(email, **config)
+            validity.append(res)
+    t1 = time.time()
+    validity = sorted(validity, key=lambda x: x['email'])
+
+    for v in validity:
+         pprint.pprint(v, indent=4)
+
+    print(f"Time taken: {t1 - t0:.2f}")

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/common_functions/file_functions.py

@@ -31,6 +31,10 @@ file_functions.delete_file("test.csv")
 
 # Outputs: 'complete'
 ```
+
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
 """
 
 # Import required modules

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/common_functions/folder_functions.py

@@ -31,7 +31,12 @@ folder_functions.remove_folder("/path/to/directory/old_folder")  # Removes the
 folder at '/path/to/directory/old_folder'
 
 ```
+
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
 """
+
 import re
 from datetime import datetime
 from pathlib import Path

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/common_functions/logging_config.py

@@ -30,6 +30,10 @@ logger.error("This is an error message")
 logger.warning("This is a warning message")
 logger.critical("This is a critical message")
 ```
+
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
 """
 
 import logging

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/common_functions/patterns.py

@@ -33,6 +33,10 @@ Example:
     }
     ```
 
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
+
 """
 import re
 

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/fastapi_functions/_all_codes.py

@@ -31,6 +31,10 @@ Example:
     link_500 = ALL_HTTP_CODES[500]['link']
     print(link_500)  # Output: 'https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500'
     ```
+
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
 """
 
 ALL_HTTP_CODES = {

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/fastapi_functions/http_codes.py

@@ -23,6 +23,10 @@ Attributes:
     ALL_HTTP_CODES (dict): A dictionary of HTTP status codes. Each key is an
     HTTP status code (int), and each value is another dictionary with keys
     'description' (str), 'extended_description' (str), and 'link' (str).
+
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
 """
 from loguru import logger
 

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/dsg_lib/fastapi_functions/system_health_endpoints.py

@@ -62,6 +62,10 @@ Example:
     # {"memory_use":{"current": "123456", "peak": "789012"}, "heap_dump": [{"filename": "main.py", "lineno": 10, "size": 1234, "count": 1}, ...]}
 
     ```
+
+Author: Mike Ryan
+Date: 2024/05/16
+License: MIT
 """
 
 # Import necessary modules

{devsetgo_lib-0.12.2 → devsetgo_lib-0.12.4}/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "devsetgo_lib"
-version = "0.12.2"
+version = "0.12.4"
 requires-python = ">=3.9"
 description = "DevSetGo Common Library provides reusable Python functions for enhanced code efficiency. It includes utilities for file operations, calendar, pattern matching, logging, FastAPI endpoints, and async database handling with CRUD operations."
 readme = "README.md"
@@ -34,6 +34,7 @@ classifiers = [
 dependencies = [
     "loguru>=0.7.0",
     "packaging>=20.0",
+    "email-validator>=2.1.1"
 ]
 # loguru = ">=0.7.0"
 # packaging = ">=20.0"
@@ -86,20 +87,23 @@ unsafe-fixes = true
 # Assume Python 3.8
 target-version = "py312"
 src = ["dsg_lib", "test"]
-exclude = ["unreleased/*","examples/*","scripts/*"]
+exclude = ["unreleased/*","scripts/*","coverage.xml","coverage-badge.svg"] #,"examples/*"
+
+[tool.ruff.lint]
 select = [
     "C",  # mccabe rules
     "F",  # pyflakes rules
     "E",  # pycodestyle error rules
     "W",  # pycodestyle warning rules
     "B",  # flake8-bugbear rules
-    "I",  # isort rules
 ]
 ignore = [
     "C901",  # max-complexity-10
     "E501",  # line-too-long
     "B017",
-    "B904"
+    "B904",
+    "B008",
+    "I",  # isort rules
 ]
 
 [tool.ruff.format]
@@ -134,7 +138,7 @@ multi_line_output = 3
 include_trailing_comma = true
 force_grid_wrap = 0
 use_parentheses = true
-line_length = 88
+line_length = 100
 
 [tool.coverage.run]
 source = ["dsg_lib"]