wcp-library 1.0.0__tar.gz

wcp_library-1.0.0/PKG-INFO

@@ -0,0 +1,46 @@
+Metadata-Version: 2.1
+Name: wcp-library
+Version: 1.0.0
+Summary: Common utilites for internal development at WCP
+Home-page: https://github.com/Whitecap-DNA/WCP-Library
+Author: Mitch-Petersen
+Author-email: mitch.petersen@wcap.ca
+Requires-Python: >=3.11,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: aiohttp (>=3.10.10,<4.0.0)
+Requires-Dist: oracledb (>=2.5.0,<3.0.0)
+Requires-Dist: pandas (>=2.2.3,<3.0.0)
+Requires-Dist: pip-system-certs (>=4.0,<5.0)
+Requires-Dist: psycopg (>=3.2.3,<4.0.0)
+Requires-Dist: psycopg-binary (>=3.2.3,<4.0.0)
+Requires-Dist: psycopg-pool (>=3.2.3,<4.0.0)
+Requires-Dist: pycryptodome (>=3.21.0,<4.0.0)
+Requires-Dist: requests (>=2.32.3,<3.0.0)
+Requires-Dist: yarl (>=1.17.1,<2.0.0)
+Project-URL: Documentation, https://github.com/Whitecap-DNA/WCP-Library/wiki
+Project-URL: Repository, https://github.com/Whitecap-DNA/WCP-Library
+Description-Content-Type: text/markdown
+
+# WCP-Library
+
+## Description
+Commonly used functions for the D&A team.
+
+## Installation
+`pip install WCP-Library`
+
+## Usage
+See Wiki for more information.
+
+## Authors and acknowledgment
+Mitch Petersen
+
+## Stakeholders
+D&A Developers
+
+## Project status
+In Development
+

wcp_library-1.0.0/README.md

@@ -0,0 +1,19 @@
+# WCP-Library
+
+## Description
+Commonly used functions for the D&A team.
+
+## Installation
+`pip install WCP-Library`
+
+## Usage
+See Wiki for more information.
+
+## Authors and acknowledgment
+Mitch Petersen
+
+## Stakeholders
+D&A Developers
+
+## Project status
+In Development

wcp_library-1.0.0/pyproject.toml

@@ -0,0 +1,26 @@
+[tool.poetry]
+name = "wcp-library"
+version = "1.0.0"
+description = "Common utilites for internal development at WCP"
+authors = ["Mitch-Petersen <mitch.petersen@wcap.ca>"]
+readme = "README.md"
+repository = "https://github.com/Whitecap-DNA/WCP-Library"
+documentation = "https://github.com/Whitecap-DNA/WCP-Library/wiki"
+packages = [{include = "wcp_library"}]
+
+[tool.poetry.dependencies]
+python = "^3.11"
+aiohttp = "^3.10.10"
+oracledb = "^2.5.0"
+pandas = "^2.2.3"
+pip-system-certs = "^4.0"
+psycopg = "^3.2.3"
+psycopg-binary = "^3.2.3"
+psycopg-pool = "^3.2.3"
+pycryptodome = "^3.21.0"
+requests = "^2.32.3"
+yarl = "^1.17.1"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

wcp_library-1.0.0/wcp_library/__init__.py

@@ -0,0 +1,14 @@
+import os
+import sys
+from pathlib import Path
+
+# PyInstaller import
+import pip_system_certs.wrapt_requests
+
+
+# Application Path
+if getattr(sys, 'frozen', False):
+    application_path = sys.executable + '-'
+    application_path = Path(application_path).parent
+else:
+    application_path = Path(os.path.dirname(os.path.abspath(__file__)))

wcp_library-1.0.0/wcp_library/async_credentials/__init__.py

@@ -0,0 +1,49 @@
+import secrets
+import string
+
+
+class MissingCredentialsError(KeyError):
+    pass
+
+
+async def generate_password(length: int=12, use_nums: bool=True, use_special: bool=True, special_chars_override: list=None, force_num: bool=True, force_spec: bool=True) -> str:
+    """
+    Function to generate a random password
+
+    :param length:
+    :param use_nums: Allows the use of numbers
+    :param use_special: Allows the use of special characters
+    :param special_chars_override: List of special characters to use
+    :param force_num: Requires the password to contain at least one number
+    :param force_spec: Requires the password to contain at least one special character
+    :return: Password
+    """
+
+    letters = string.ascii_letters
+    digits = string.digits
+    if special_chars_override:
+        special_chars = special_chars_override
+    else:
+        special_chars = string.punctuation
+
+    alphabet = letters
+    if use_nums:
+        alphabet += digits
+    if use_special:
+        alphabet += special_chars
+
+    pwd = ''
+    for i in range(length):
+        pwd += ''.join(secrets.choice(alphabet))
+
+    if (use_nums and force_num) and (use_special and force_spec):
+        while pwd[0].isdigit() or not any(char.isdigit() for char in pwd) or not any(char in pwd for char in special_chars):
+            pwd = await generate_password(length, use_nums, use_special, special_chars_override, force_num, force_spec)
+    elif use_nums and force_num:
+        while pwd[0].isdigit() or not any(char.isdigit() for char in pwd):
+            pwd = await generate_password(length, use_nums, use_special, special_chars_override, force_num, force_spec)
+    elif use_special and force_spec:
+        while not any(char in pwd for char in special_chars):
+            pwd = await generate_password(length, use_nums, use_special, special_chars_override, force_num, force_spec)
+
+    return pwd

wcp_library-1.0.0/wcp_library/async_credentials/oracle.py

@@ -0,0 +1,131 @@
+import logging
+
+import aiohttp
+from yarl import URL
+
+from WCP_Library.async_credentials import MissingCredentialsError
+
+logger = logging.getLogger(__name__)
+
+
+class AsyncOracleCredentialManager:
+    def __init__(self, passwordState_api_key: str):
+        self.password_url = URL("https://vault.wcap.ca/api/passwords/")
+        self.api_key = passwordState_api_key
+        self.headers = {"APIKey": self.api_key, 'Reason': 'Python Script Access'}
+        self._password_list_id = 207
+
+    async def _get_credentials(self) -> dict:
+        """
+        Get all credentials from the password list
+
+        :return:
+        """
+
+        logger.debug("Getting credentials from PasswordState")
+        url = (self.password_url / str(self._password_list_id)).with_query("QueryAll")
+        async with aiohttp.ClientSession() as session:
+            async with session.get(str(url), headers=self.headers) as response:
+                passwords = await response.json()
+
+        if not passwords:
+            raise MissingCredentialsError("No credentials found in this Password List")
+
+        password_dict = {}
+        for password in passwords:
+            password_info = {'PasswordID': password['PasswordID'], 'UserName': password['UserName'], 'Password': password['Password']}
+            for field in password['GenericFieldInfo']:
+                password_info[field['DisplayName']] = field['Value'].lower() if field['DisplayName'].lower() == 'username' else field['Value']
+            password_dict[password['UserName'].lower()] = password_info
+        logger.debug("Credentials retrieved")
+        return password_dict
+
+    async def get_credentials(self, username: str) -> dict:
+        """
+        Get the credentials for a specific username
+
+        :param username:
+        :return:
+        """
+
+        logger.debug(f"Getting credentials for {username}")
+        credentials = await self._get_credentials()
+
+        try:
+            return_credential = credentials[username.lower()]
+        except KeyError:
+            raise MissingCredentialsError(f"Credentials for {username} not found in this Password List")
+        logger.debug(f"Credentials for {username} retrieved")
+        return return_credential
+
+    async def update_credential(self, credentials_dict: dict) -> bool:
+        """
+        Update username and password in PasswordState
+
+        Credentials dictionary must have the following keys:
+            - PasswordID
+            - UserName
+            - Password
+
+        The dictionary can be obtained from the get_credentials method
+
+        :param credentials_dict:
+        :return:
+        """
+
+        logger.debug(f"Updating credentials for {credentials_dict['UserName']}")
+        url = (self.password_url / str(self._password_list_id)).with_query("QueryAll")
+        async with aiohttp.ClientSession() as session:
+            async with session.get(str(url), headers=self.headers) as response:
+                passwords = await response.json()
+
+        relevant_credential_entry = [x for x in passwords if x['UserName'] == credentials_dict['UserName']][0]
+        for field in relevant_credential_entry['GenericFieldInfo']:
+            if field['DisplayName'] in credentials_dict:
+                credentials_dict[field['GenericFieldID']] = credentials_dict[field['DisplayName']]
+                credentials_dict.pop(field['DisplayName'])
+
+        async with aiohttp.ClientSession() as session:
+            async with session.put(str(self.password_url), json=credentials_dict, headers=self.headers) as response:
+                if response.status == 200:
+                    logger.debug(f"Credentials for {credentials_dict['UserName']} updated")
+                    return True
+                else:
+                    logger.error(f"Failed to update credentials for {credentials_dict['UserName']}")
+                    return False
+
+    async def new_credentials(self, credentials_dict: dict) -> bool:
+        """
+        Create a new credential entry
+
+        Credentials dictionary must have the following keys:
+            - UserName
+            - Password
+            - Host
+            - Port
+            - Service or SID
+
+        :param credentials_dict:
+        :return:
+        """
+
+        data = {
+            "PasswordListID": self._password_list_id,
+            "Title": credentials_dict['UserName'].upper() if "Title" not in credentials_dict else credentials_dict['Title'].upper(),
+            "Notes": credentials_dict['Notes'] if 'Notes' in credentials_dict else None,
+            "UserName": credentials_dict['UserName'].lower(),
+            "Password": credentials_dict['Password'],
+            "GenericField1": credentials_dict['Host'],
+            "GenericField2": credentials_dict['Port'],
+            "GenericField3": credentials_dict['Service'] if 'Service' in credentials_dict else None,
+            "GenericField4": credentials_dict['SID'] if 'SID' in credentials_dict else None
+        }
+
+        async with aiohttp.ClientSession() as session:
+            async with session.put(str(self.password_url), json=data, headers=self.headers) as response:
+                if response.status == 201:
+                    logger.debug(f"New credentials for {credentials_dict['UserName']} created")
+                    return True
+                else:
+                    logger.error(f"Failed to create new credentials for {credentials_dict['UserName']}")
+                    return False

wcp_library-1.0.0/wcp_library/async_credentials/postgres.py

@@ -0,0 +1,130 @@
+import logging
+
+import aiohttp
+from yarl import URL
+
+from WCP_Library.async_credentials import MissingCredentialsError
+
+logger = logging.getLogger(__name__)
+
+
+class AsyncPostgresCredentialManager:
+    def __init__(self, passwordState_api_key: str):
+        self.password_url = URL("https://vault.wcap.ca/api/passwords/")
+        self.api_key = passwordState_api_key
+        self.headers = {"APIKey": self.api_key, 'Reason': 'Python Script Access'}
+        self._password_list_id = 207
+
+    async def _get_credentials(self) -> dict:
+        """
+        Get all credentials from the password list
+
+        :return:
+        """
+
+        logger.debug("Getting credentials from PasswordState")
+        url = (self.password_url / str(self._password_list_id)).with_query("QueryAll")
+        async with aiohttp.ClientSession() as session:
+            async with session.get(str(url), headers=self.headers) as response:
+                passwords = await response.json()
+
+        if not passwords:
+            raise MissingCredentialsError("No credentials found in this Password List")
+
+        password_dict = {}
+        for password in passwords:
+            password_info = {'PasswordID': password['PasswordID'], 'UserName': password['UserName'], 'Password': password['Password']}
+            for field in password['GenericFieldInfo']:
+                password_info[field['DisplayName']] = field['Value'].lower() if field['DisplayName'].lower() == 'username' else field['Value']
+            password_dict[password['UserName'].lower()] = password_info
+        logger.debug("Credentials retrieved")
+        return password_dict
+
+    async def get_credentials(self, username: str) -> dict:
+        """
+        Get the credentials for a specific username
+
+        :param username:
+        :return:
+        """
+
+        logger.debug(f"Getting credentials for {username}")
+        credentials = await self._get_credentials()
+
+        try:
+            return_credential = credentials[username.lower()]
+        except KeyError:
+            raise MissingCredentialsError(f"Credentials for {username} not found in this Password List")
+        logger.debug(f"Credentials for {username} retrieved")
+        return return_credential
+
+    async def update_credential(self, credentials_dict: dict) -> bool:
+        """
+        Update username and password in PasswordState
+
+        Credentials dictionary must have the following keys:
+            - PasswordID
+            - UserName
+            - Password
+
+        The dictionary can be obtained from the get_credentials method
+
+        :param credentials_dict:
+        :return:
+        """
+
+        logger.debug(f"Updating credentials for {credentials_dict['UserName']}")
+        url = (self.password_url / str(self._password_list_id)).with_query("QueryAll")
+        async with aiohttp.ClientSession() as session:
+            async with session.get(str(url), headers=self.headers) as response:
+                passwords = await response.json()
+
+        relevant_credential_entry = [x for x in passwords if x['UserName'] == credentials_dict['UserName']][0]
+        for field in relevant_credential_entry['GenericFieldInfo']:
+            if field['DisplayName'] in credentials_dict:
+                credentials_dict[field['GenericFieldID']] = credentials_dict[field['DisplayName']]
+                credentials_dict.pop(field['DisplayName'])
+
+        async with aiohttp.ClientSession() as session:
+            async with session.put(str(self.password_url), json=credentials_dict, headers=self.headers) as response:
+                if response.status == 200:
+                    logger.debug(f"Credentials for {credentials_dict['UserName']} updated")
+                    return True
+                else:
+                    logger.error(f"Failed to update credentials for {credentials_dict['UserName']}")
+                    return False
+
+    async def new_credentials(self, credentials_dict: dict) -> bool:
+        """
+        Create a new credential entry
+
+        Credentials dictionary must have the following keys:
+            - UserName
+            - Password
+            - Host
+            - Port
+            - Database
+
+        :param credentials_dict:
+        :return:
+        """
+
+        data = {
+            "PasswordListID": self._password_list_id,
+            "Title": credentials_dict['UserName'].upper() if "Title" not in credentials_dict else credentials_dict['Title'].upper(),
+            "Notes": credentials_dict['Notes'] if 'Notes' in credentials_dict else None,
+            "UserName": credentials_dict['UserName'].lower(),
+            "Password": credentials_dict['Password'],
+            "GenericField1": credentials_dict['Host'],
+            "GenericField2": credentials_dict['Port'],
+            "GenericField3": credentials_dict['Database']
+        }
+
+        async with aiohttp.ClientSession() as session:
+            async with session.put(str(self.password_url), json=data, headers=self.headers) as response:
+                if response.status == 201:
+                    logger.debug(f"New credentials for {credentials_dict['UserName']} created")
+                    return True
+                else:
+                    logger.error(f"Failed to create new credentials for {credentials_dict['UserName']}")
+                    return False

wcp_library-1.0.0/wcp_library/async_sql/__init__.py

@@ -0,0 +1,35 @@
+import asyncio
+import logging
+from functools import wraps
+
+import oracledb
+import psycopg
+
+logger = logging.getLogger(__name__)
+
+
+def retry(f: callable) -> callable:
+    """
+    Decorator to retry a function
+
+    :param f: function
+    :return: function
+    """
+
+    @wraps(f)
+    async def wrapper(self, *args, **kwargs):
+        self._retry_count = 0
+        while True:
+            try:
+                return await f(self, *args, **kwargs)
+            except (oracledb.OperationalError, psycopg.OperationalError) as e:
+                error_obj, = e.args
+                if error_obj.full_code in self.retry_error_codes and self._retry_count < self.retry_limit:
+                    self._retry_count += 1
+                    logger.debug(f"{self._db_service} connection error")
+                    logger.debug(error_obj.message)
+                    logger.info("Waiting 5 minutes before retrying Oracle connection")
+                    await asyncio.sleep(300)
+                else:
+                    raise e
+    return wrapper