BobrTools 0.1.0__tar.gz

bobrtools-0.1.0/BobrTools/__init__.py

@@ -0,0 +1,3 @@
+from .google_docs import GoogleDocs
+from .db_connectors import SnowflakeConnector
+from .telegram_client import TelegramClient

bobrtools-0.1.0/BobrTools/db_connectors.py

@@ -0,0 +1,131 @@
+import socks
+import socket
+import logging
+import pandas as pd
+import snowflake.connector
+from snowflake.connector.pandas_tools import write_pandas
+from .helpers import get_env_variable
+
+logger = logging.getLogger(__name__)
+
+
+class SnowflakeConnector:
+    def __init__(
+        self, user=None, password=None, account=None, default_warehouse=None, default_database=None, default_schema=None,
+        default_role=None, use_proxy=True, proxy_host=None, proxy_port=None, proxy_username=None, proxy_password=None
+    ):
+        self.user = user or get_env_variable("SNOWFLAKE_USER")
+        self.password = password or get_env_variable("SNOWFLAKE_PASSWORD")
+        self.account = account or get_env_variable("SNOWFLAKE_ACCOUNT")
+        self.default_role = default_role or get_env_variable("SNOWFLAKE_ROLE")
+        self.default_warehouse = default_warehouse or get_env_variable("SNOWFLAKE_WAREHOUSE")
+        self.default_database = default_database or get_env_variable("SNOWFLAKE_DATABASE")
+        self.default_schema = default_schema or get_env_variable("SNOWFLAKE_SCHEMA")
+        self.use_proxy = use_proxy
+
+        if self.use_proxy:
+            self.default_socket = socket.socket
+            self.proxy_host = proxy_host or get_env_variable("PROXY_HOST")
+            self.proxy_port = proxy_port or int(get_env_variable("PROXY_PORT"))
+            self.proxy_username = proxy_username or get_env_variable("PROXY_USERNAME")
+            self.proxy_password = proxy_password or get_env_variable("PROXY_PASSWORD")
+
+    def init_proxy(self):
+        """
+        Configures a SOCKS5 proxy for Snowflake connections.
+        """
+        socks.set_default_proxy(
+            socks.SOCKS5,
+            addr=self.proxy_host,
+            port=self.proxy_port,
+            username=self.proxy_username,
+            password=self.proxy_password,
+        )
+        socket.socket = socks.socksocket
+
+    def reset_proxy(self):
+        """
+        Resets the proxy settings to default.
+        """
+        socket.socket = self.default_socket
+
+    def connect(self, role=None, warehouse=None, database=None, schema=None):
+        """
+        Establishes and returns a connection to Snowflake, with optional overrides
+        for warehouse, database, and schema.
+        :param role: Name of the Snowflake role to override.
+        :param warehouse: Name of the Snowflake warehouse to override.
+        :param database: Name of the Snowflake database to override.
+        :param schema: Name of the Snowflake schema to override.
+        :return: Snowflake connection object.
+        """
+        return snowflake.connector.connect(
+            user=self.user,
+            password=self.password,
+            account=self.account,
+            role=role or self.default_role,
+            warehouse=warehouse or self.default_warehouse,
+            database=database or self.default_database,
+            schema=schema or self.default_schema
+        )
+
+    def upload_dataframe(
+        self, dataframe, table_name, overwrite=True, auto_create_table=True, warehouse=None, database=None, schema=None
+    ):
+        """
+        Uploads a Pandas DataFrame to a Snowflake table, with optional overrides
+        for warehouse, database, and schema.
+        Temporarily enables proxy if configured.
+        :param dataframe: pandas DataFrame to upload.
+        :param table_name: Name of the target table in Snowflake.
+        :param overwrite: When true, and if auto_create_table is true, then it drops the table. Otherwise, it
+        :param auto_create_table: When true, will automatically create a table with corresponding columns for each
+            column in the passed in DataFrame. The table will not be created if it already exist
+        :param warehouse: Name of the Snowflake warehouse to override.
+        :param database: Name of the Snowflake database to override.
+        :param schema: Name of the Snowflake schema to override.
+        :return: None.
+        :raises Exception: If the upload fails.
+        """
+        try:
+            if self.use_proxy:
+                self.init_proxy()
+
+            conn = self.connect(warehouse=warehouse, database=database, schema=schema)
+            try:
+                success, nchunks, nrows, _ = write_pandas(
+                    conn,
+                    dataframe,
+                    table_name,
+                    overwrite=overwrite,
+                    auto_create_table=auto_create_table
+                )
+                if success:
+                    logger.info(
+                        f"DataFrame successfully uploaded to table '{table_name}' in database '{database or self.default_database}' "
+                        f"and schema '{schema or self.default_schema}'. Rows inserted: {nrows}")
+                else:
+                    raise Exception("Failed to upload DataFrame to Snowflake.")
+            finally:
+                conn.close()
+        finally:
+            if self.use_proxy:
+                self.reset_proxy()
+
+    def get_dataframe(self, query, warehouse=None, database=None, schema=None):
+        try:
+            if self.use_proxy:
+                self.init_proxy()
+
+            conn = self.connect(warehouse=warehouse, database=database, schema=schema)
+            cursor = conn.cursor()
+            cursor.execute(query)
+            dataframe = pd.DataFrame(cursor.fetchall(), columns=[column[0] for column in cursor.description])
+            cursor.close()
+            conn.close()
+
+            return dataframe
+
+        finally:
+            if self.use_proxy:
+                self.reset_proxy()

bobrtools-0.1.0/BobrTools/google_docs.py

@@ -0,0 +1,93 @@
+import time
+import gspread
+import pandas as pd
+from gspread import utils
+from oauth2client.service_account import ServiceAccountCredentials
+from tenacity import (
+    retry,
+    wait_incrementing,
+    stop_after_attempt,
+)
+from gspread_formatting import (
+    set_frozen,
+    format_cell_range,
+    format_cell_ranges,
+    CellFormat,
+    Color,
+    TextFormat,
+    NumberFormat,
+)
+
+
+class GoogleDocs:
+    def __init__(self, keyfile=None):
+        """
+        Initializes the GoogleDocs class with credentials for Google API.
+        :param keyfile: Path to the JSON file containing Google service account credentials.
+        Defaults to "./credentials.json" if not provided.
+        """
+        if keyfile is None:
+            keyfile = "./credentials.json"
+
+        scope = ["https://spreadsheets.google.com/feeds", "https://www.googleapis.com/auth/drive"]
+        credentials = ServiceAccountCredentials.from_json_keyfile_name(keyfile, scope)
+        self.spreadsheet = None
+        self.gc = gspread.authorize(credentials)
+
+    @staticmethod
+    @retry(wait=wait_incrementing(start=60, increment=30, max=300), stop=stop_after_attempt(5))
+    def safe_execute(func, *args, **kwargs):
+        time.sleep(2)
+        return func(*args, **kwargs)
+
+    def format_worksheet(self, worksheet, headers):
+        header_range = utils.rowcol_to_a1(1, 1) + ":" + utils.rowcol_to_a1(1, len(headers))
+        header_format = CellFormat(
+            backgroundColor=Color(201/255, 218/255, 248/255),
+            textFormat=TextFormat(bold=True),
+            horizontalAlignment="CENTER",
+            wrapStrategy="WRAP"
+        )
+        self.safe_execute(format_cell_range, worksheet, header_range, header_format)
+        worksheet.freeze(rows=1)
+
+    def get_dataframe(self, spreadsheet_key, worksheet_index=0, worksheet_title=None) -> pd.DataFrame:
+        """
+        Returns a worksheet from a Google Spreadsheet as a pandas DataFrame.
+        :param spreadsheet_key: ID of the Google Spreadsheet.
+        :param worksheet_index: Index of the worksheet (default: 0).
+        :param worksheet_title: Title of the worksheet (overrides index if set).
+        :return: pandas DataFrame with the worksheet data.
+        """
+        spreadsheet = self.gc.open_by_key(spreadsheet_key)
+        if worksheet_title:
+            worksheet = spreadsheet.worksheet(worksheet_title)
+        else:
+            worksheet = spreadsheet.get_worksheet(worksheet_index)
+        data = worksheet.get_all_values()
+        return pd.DataFrame(data[1:], columns=data[0])
+
+    def write_dataframe(
+        self, dataframe, worksheet_title, default_dataframe_formatting: bool = False, spreadsheet_key=None
+    ):
+
+        if spreadsheet_key:
+            self.spreadsheet = self.gc.open_by_key(spreadsheet_key)
+        else:
+            self.spreadsheet = self.gc.create(title="new", folder_id="")
+
+        try:
+            worksheet = self.spreadsheet.worksheet(worksheet_title)
+        except gspread.WorksheetNotFound:
+            worksheet = self.spreadsheet.add_worksheet(title=worksheet_title, rows=100, cols=20)
+
+        data = [dataframe.columns.values.tolist()] + dataframe.values.tolist()
+
+        worksheet.clear()
+        worksheet.update(data)
+
+        if default_dataframe_formatting:
+            columns = dataframe.columns.values.tolist()
+            self.format_worksheet(worksheet=worksheet, headers=columns)
+
+

bobrtools-0.1.0/BobrTools/helpers.py

@@ -0,0 +1,17 @@
+import os
+
+
+def get_env_variable(var_name, required=True):
+    """
+    Retrieves the value of an environment variable and performs validation.
+    :param var_name: Name of the environment variable.
+    :param required: If True, raises an error if the variable is not set.
+    :return: The value of the environment variable (or None if not required and not set).
+    :raises EnvironmentError: If the variable is required but not set.
+    """
+    value = os.environ.get(var_name)
+
+    if required and not value:
+        raise EnvironmentError(f"Environment variable '{var_name}' is not set.")
+
+    return value

bobrtools-0.1.0/BobrTools/telegram_client.py

@@ -0,0 +1,28 @@
+import time
+import telegram
+from .helpers import get_env_variable
+from telegram.error import RetryAfter, TimedOut
+
+
+class TelegramClient:
+    def __init__(self, token=None):
+        self.token = token or get_env_variable("TELEGRAM_BOT_TOKEN")
+        self.telegram = telegram.Bot(token=self.token)
+
+    async def send_message(self, chat_id, text, parse_mode=None, max_retries=5, timeout_delay=5):
+        retries = 0
+
+        while retries < max_retries:
+            try:
+                return await self.telegram.send_message(
+                    chat_id=chat_id,
+                    text=text,
+                    parse_mode=parse_mode
+                )
+            except RetryAfter as e:
+                wait_time = int(e.retry_after) + 1
+                time.sleep(wait_time)
+            except TimedOut:
+                time.sleep(timeout_delay)
+
+            retries += 1

bobrtools-0.1.0/BobrTools.egg-info/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: BobrTools
+Version: 0.1.0
+Summary: Tools designed to simplify routine tasks for analysts, enabling faster and more efficient data processing and analysis
+Author: Artsem Bobr
+Author-email: artyombobr@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: gspread>=6.1.4
+Requires-Dist: oauth2client>=4.1.3
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: setuptools>=68.2.2
+Requires-Dist: snowflake_connector_python>=3.10.1
+Requires-Dist: snowflake_snowpark_python>=1.17.0
+Requires-Dist: pysocks>=1.7.1

bobrtools-0.1.0/BobrTools.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+README.md
+setup.py
+BobrTools/__init__.py
+BobrTools/db_connectors.py
+BobrTools/google_docs.py
+BobrTools/helpers.py
+BobrTools/telegram_client.py
+BobrTools.egg-info/PKG-INFO
+BobrTools.egg-info/SOURCES.txt
+BobrTools.egg-info/dependency_links.txt
+BobrTools.egg-info/requires.txt
+BobrTools.egg-info/top_level.txt

bobrtools-0.1.0/BobrTools.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

bobrtools-0.1.0/BobrTools.egg-info/requires.txt

@@ -0,0 +1,7 @@
+gspread>=6.1.4
+oauth2client>=4.1.3
+pandas>=2.2.3
+setuptools>=68.2.2
+snowflake_connector_python>=3.10.1
+snowflake_snowpark_python>=1.17.0
+pysocks>=1.7.1

bobrtools-0.1.0/BobrTools.egg-info/top_level.txt

@@ -0,0 +1 @@
+BobrTools

bobrtools-0.1.0/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.1
+Name: BobrTools
+Version: 0.1.0
+Summary: Tools designed to simplify routine tasks for analysts, enabling faster and more efficient data processing and analysis
+Author: Artsem Bobr
+Author-email: artyombobr@gmail.com
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: gspread>=6.1.4
+Requires-Dist: oauth2client>=4.1.3
+Requires-Dist: pandas>=2.2.3
+Requires-Dist: setuptools>=68.2.2
+Requires-Dist: snowflake_connector_python>=3.10.1
+Requires-Dist: snowflake_snowpark_python>=1.17.0
+Requires-Dist: pysocks>=1.7.1

bobrtools-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

bobrtools-0.1.0/setup.py

@@ -0,0 +1,24 @@
+from setuptools import setup, find_packages
+
+with open("requirements.txt") as f:
+    install_requires = f.read().splitlines()
+
+setup(
+    name="BobrTools",
+    version="0.1.0",
+    description="Tools designed to simplify routine tasks for analysts, enabling faster "
+                "and more efficient data processing and analysis",
+    long_description=open("README.md", "r", encoding="utf-8").read(),
+    long_description_content_type="text/markdown",
+    author="Artsem Bobr",
+    author_email="artyombobr@gmail.com",
+    license="MIT",
+    packages=find_packages(),
+    install_requires=install_requires,
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.9",
+)