fullscript.spellbook 2.1__py3-none-any.whl

fullscript.spellbook-2.1.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Fullscript
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fullscript.spellbook-2.1.dist-info/METADATA

@@ -0,0 +1,208 @@
+Metadata-Version: 2.2
+Name: fullscript.spellbook
+Version: 2.1
+Summary: A simple package to make your life easier.
+Author: Gui Chagas, David King, Meinhard Mare, Karsten Melchers
+Author-email: Thomas Edwards <thomas.edwards@fullscript.com>
+License: MIT
+Project-URL: homepage, https://git.fullscript.io/data/spellbook
+Requires-Python: <3.12,>=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: appnope==0.1.4
+Requires-Dist: asn1crypto==1.5.1
+Requires-Dist: asttokens==2.4.1
+Requires-Dist: snowflake-sqlalchemy==1.7.0
+Requires-Dist: certifi==2024.8.30
+Requires-Dist: cffi==1.17.1
+Requires-Dist: charset-normalizer==3.4.0
+Requires-Dist: cloudpickle==2.2.1
+Requires-Dist: comm==0.2.2
+Requires-Dist: cryptography==43.0.3
+Requires-Dist: debugpy==1.8.8
+Requires-Dist: decorator==5.1.1
+Requires-Dist: executing==2.1.0
+Requires-Dist: filelock==3.16.1
+Requires-Dist: idna==3.10
+Requires-Dist: ipykernel==6.29.5
+Requires-Dist: ipython==8.29.0
+Requires-Dist: jedi==0.19.2
+Requires-Dist: jupyter_client==8.6.3
+Requires-Dist: jupyter_core==5.7.2
+Requires-Dist: matplotlib-inline==0.1.7
+Requires-Dist: nest-asyncio==1.6.0
+Requires-Dist: numpy==2.1.3
+Requires-Dist: packaging==24.2
+Requires-Dist: pandas==2.2.3
+Requires-Dist: parso==0.8.4
+Requires-Dist: pexpect==4.9.0
+Requires-Dist: platformdirs==4.3.6
+Requires-Dist: prompt_toolkit==3.0.48
+Requires-Dist: protobuf==5.28.3
+Requires-Dist: psutil==6.1.0
+Requires-Dist: ptyprocess==0.7.0
+Requires-Dist: pure_eval==0.2.3
+Requires-Dist: pyarrow==18.0.0
+Requires-Dist: pycparser==2.22
+Requires-Dist: Pygments==2.18.0
+Requires-Dist: PyJWT==2.9.0
+Requires-Dist: pyOpenSSL==24.2.1
+Requires-Dist: python-dateutil==2.9.0.post0
+Requires-Dist: pytz==2024.2
+Requires-Dist: PyYAML==6.0.2
+Requires-Dist: pyzmq==26.2.0
+Requires-Dist: requests==2.32.3
+Requires-Dist: six==1.16.0
+Requires-Dist: snowflake-connector-python==3.12.3
+Requires-Dist: snowflake-snowpark-python==1.25.0
+Requires-Dist: sortedcontainers==2.4.0
+Requires-Dist: SQLAlchemy==2.0.36
+Requires-Dist: stack-data==0.6.3
+Requires-Dist: tomlkit==0.13.2
+Requires-Dist: tornado==6.4.1
+Requires-Dist: traitlets==5.14.3
+Requires-Dist: typing_extensions==4.12.2
+Requires-Dist: tzdata==2024.2
+Requires-Dist: tzlocal==5.2
+Requires-Dist: urllib3==2.2.3
+Requires-Dist: wcwidth==0.2.13
+Provides-Extra: drivemagic
+Requires-Dist: cachetools==5.5.0; extra == "drivemagic"
+Requires-Dist: google-api-core==2.23.0; extra == "drivemagic"
+Requires-Dist: google-api-python-client==2.153.0; extra == "drivemagic"
+Requires-Dist: google-auth==2.36.0; extra == "drivemagic"
+Requires-Dist: google-auth-httplib2==0.2.0; extra == "drivemagic"
+Requires-Dist: google-auth-oauthlib==1.2.1; extra == "drivemagic"
+Requires-Dist: googleapis-common-protos==1.66.0; extra == "drivemagic"
+Requires-Dist: httplib2==0.22.0; extra == "drivemagic"
+Requires-Dist: oauthlib==3.2.2; extra == "drivemagic"
+Requires-Dist: proto-plus==1.25.0; extra == "drivemagic"
+Requires-Dist: pyasn1==0.6.1; extra == "drivemagic"
+Requires-Dist: pyasn1_modules==0.4.1; extra == "drivemagic"
+Requires-Dist: pyparsing==3.2.0; extra == "drivemagic"
+Requires-Dist: requests-oauthlib==2.0.0; extra == "drivemagic"
+Requires-Dist: rsa==4.9; extra == "drivemagic"
+Requires-Dist: uritemplate==4.1.1; extra == "drivemagic"
+Provides-Extra: sheetmagic
+Requires-Dist: cachetools==5.5.0; extra == "sheetmagic"
+Requires-Dist: google-api-core==2.23.0; extra == "sheetmagic"
+Requires-Dist: google-api-python-client==2.153.0; extra == "sheetmagic"
+Requires-Dist: google-auth==2.36.0; extra == "sheetmagic"
+Requires-Dist: google-auth-httplib2==0.2.0; extra == "sheetmagic"
+Requires-Dist: google-auth-oauthlib==1.2.1; extra == "sheetmagic"
+Requires-Dist: googleapis-common-protos==1.66.0; extra == "sheetmagic"
+Requires-Dist: httplib2==0.22.0; extra == "sheetmagic"
+Requires-Dist: oauthlib==3.2.2; extra == "sheetmagic"
+Requires-Dist: pyasn1==0.6.1; extra == "sheetmagic"
+Requires-Dist: pyasn1_modules==0.4.1; extra == "sheetmagic"
+Requires-Dist: Pygments==2.18.0; extra == "sheetmagic"
+Requires-Dist: pygsheets==2.0.6; extra == "sheetmagic"
+Requires-Dist: pyparsing==3.2.0; extra == "sheetmagic"
+Requires-Dist: requests-oauthlib==2.0.0; extra == "sheetmagic"
+Requires-Dist: rsa==4.9; extra == "sheetmagic"
+Requires-Dist: uritemplate==4.1.1; extra == "sheetmagic"
+Provides-Extra: statsmagic
+Requires-Dist: contourpy==1.3.1; extra == "statsmagic"
+Requires-Dist: cycler==0.12.1; extra == "statsmagic"
+Requires-Dist: fonttools==4.55.0; extra == "statsmagic"
+Requires-Dist: kiwisolver==1.4.7; extra == "statsmagic"
+Requires-Dist: matplotlib==3.9.2; extra == "statsmagic"
+Requires-Dist: patsy==1.0.1; extra == "statsmagic"
+Requires-Dist: pillow==11.0.0; extra == "statsmagic"
+Requires-Dist: pyparsing==3.2.0; extra == "statsmagic"
+Requires-Dist: python-dateutil==2.9.0.post0; extra == "statsmagic"
+Requires-Dist: pytz==2024.2; extra == "statsmagic"
+Requires-Dist: scikit-posthocs==0.10.0; extra == "statsmagic"
+Requires-Dist: scipy==1.14.1; extra == "statsmagic"
+Requires-Dist: seaborn==0.13.2; extra == "statsmagic"
+Requires-Dist: six==1.16.0; extra == "statsmagic"
+Requires-Dist: statsmodels==0.14.4; extra == "statsmagic"
+
+# Spellbook
+
+Helping data scientists and engineers save time by making it simple to connect to databases, work with spreadsheets, 
+manage files, and run analyses. With Spellbook, they can focus on finding insights and solving problems instead of 
+dealing with complicated tools.
+
+With Spellbook, you can:
+* Seamlessly connect to Snowflake and MySQL databases, for secure querying and effortless data retrieval.
+* Work with Google Sheets, making it easy to read, write, and update spreadsheets.
+* Manage Google Drive, creating folders and saving files with ease. 
+* Perform statistical analyses, helping you run A/B tests and extract actionable insights.
+
+Spellbook is built to simplify your workflows and supercharge your data exploration, so you can focus on turning insights into action!
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+
+- Effortless Database Connections and query execution
+- Read/ Write to Google worksheets
+- Manage Google Drive
+- Perform statistical analyses
+
+For feature methods and examples, please refer to the [Wiki Page](https://git.fullscript.io/data/spellbook/-/wikis/home).
+
+
+## Installation
+
+Spellbook requires Python 3.11 or higher. Use the following steps to install:
+> Note: At the time relase, Snowpark does not support versions of Python higher than 3.11
+
+1. Pip install:
+
+```bash
+pip install git+https://git.fullscript.io/data/spellbook.git
+```
+
+## Configuration
+Effortlessly and securely manage your connections and configurations! Simply add database types and connection 
+credentials to your [spellbook_config.yaml](spellbook_config.yaml) file, or include your Google service account details for seamless access to 
+Google services. For added security, Spellbook supports storing credentials in environment variables 
+or in a configuration file that references those variables, keeping your sensitive information safe and sound.
+
+You must have a `spellbook_config.yaml` file in your root directory or in your project directory.
+An example of the `spellbook_config.yaml` file is shown below:
+
+```yaml
+databases:
+  # Snowflake Database Connection
+  - name: alias_of_your_connection
+    type: snowflake
+    account: your_account
+    user: snowflake_user_name # Optional for private key auth
+    password: snowflake_password # Optional, used if private key is not present
+    private_key: snowflake_pk # Base64-encoded private key
+    private_key_passphrase: snowflake_pk_phrase # Optional
+    role: snowflake_role
+    warehouse: snowflake_warehouse
+    database: snowflake_database
+    schema: snowflake_schema
+
+google_accounts:
+  # Google Sheets Service Account 1
+  - name: google_sheets_service_account_1
+    service_account: "your_base64_encoded_service_account_credentials_here"  # Add your Base64-encoded service account JSON here
+```
+
+## Contributing
+
+We welcome contributions! Please follow these steps:
+
+1. Fork this repository.
+2. Create a new branch: `git checkout -b feature-name`.
+3. Commit your changes: `git commit -m 'Add some feature'`.
+4. Push to the branch: `git push origin feature-name`.
+5. Open a pull request.
+
+## License
+
+Spellbook is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
+
+---

fullscript.spellbook-2.1.dist-info/RECORD

@@ -0,0 +1,23 @@
+spellbook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+spellbook/db_magic.py,sha256=rRQm6EL7vRvO7rR9snF0_RlJTRfmFq9gvWvh7L9BYbM,8579
+spellbook/drive_magic.py,sha256=uZH-nAOgBXO_NHm4OJ3xX3jPAS11jTj0bkfNd8pBLis,9594
+spellbook/sheet_magic.py,sha256=a8ZQE3ifFJpsptfHyj4ku-hrbeBM8qL3zW5Sy-HjL_c,8186
+spellbook/stats_magic.py,sha256=8uwq-n4NWDYzUUFZAX17Ls1jWcFj17l-BFqeF8VrTPQ,7655
+spellbook/utils.py,sha256=DQ1R3dZxhnEvUMixvy28oyCuJw63MudwJLnCs_yIyQ8,3306
+spellbook/wizards/wizard1.txt,sha256=6F-jH4EJ5birPbFrD4HhxIUBLtP2wTlUZcJjNV5upAg,285
+spellbook/wizards/wizard10.txt,sha256=NjT8pIZs60nahK-7Z6mkIdUgoUNeaBj0qU4NdWrM7aM,798
+spellbook/wizards/wizard11.txt,sha256=ioKNImgjRTQNQdmeSagmeMAnDNhldCbcLHHy9EuPG0Y,565
+spellbook/wizards/wizard12.txt,sha256=78fVVYHbSqf5AqI7xgSZNvznpdKtKXOhzvPBaJO5Dic,462
+spellbook/wizards/wizard2.txt,sha256=8zgsC2-msh4QGez3Ivv1VuurQBGyeFiyuVNs9VfWkA8,57
+spellbook/wizards/wizard3.txt,sha256=QO8cQa9HsqtTaUMNDqvic8ySRBx6O1QYst2plGaqjFE,61
+spellbook/wizards/wizard4.txt,sha256=eLBEHHiX2aCADRmlXUg5PiovZKHnbF4Uz9uM5PsasKo,146
+spellbook/wizards/wizard5.txt,sha256=3Vm-KdTUnq34IGxd_kMeWY5j_LHlzYPvAkRtkqq1i3w,129
+spellbook/wizards/wizard6.txt,sha256=mQ0FNaRrh-q5B6MiJZ1MO4XCdqsPvj_tGOhIZJDfHis,115
+spellbook/wizards/wizard7.txt,sha256=ssaQtCSfUaLOgq7-gu0Ao74GFa7FkN8lCjOMIiGL4Ak,86
+spellbook/wizards/wizard8.txt,sha256=ZVgn0KzC0g71_lnzvYf8XbSbrGEqFHS_n3JjRFEvrOg,684
+spellbook/wizards/wizard9.txt,sha256=ROHeUtq9k66goCVsLctpPgx3U_UxAJzBtSVyWhFfho0,1435
+fullscript.spellbook-2.1.dist-info/LICENSE,sha256=RG9zQfX4eYYNV_n6_zvsKucXCgPqSAXBUQkkPEJJUQg,1066
+fullscript.spellbook-2.1.dist-info/METADATA,sha256=QOFJ_R6PcEPoqjJCptiK5scoqzOLl__Y3TDnjF7L2_Y,8465
+fullscript.spellbook-2.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+fullscript.spellbook-2.1.dist-info/top_level.txt,sha256=mL7M9kCzo_sE_bt4FPXIdHtCV8YiDCAH8kkdOSI3yqw,10
+fullscript.spellbook-2.1.dist-info/RECORD,,

fullscript.spellbook-2.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (75.8.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fullscript.spellbook-2.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+spellbook

spellbook/db_magic.py

@@ -0,0 +1,266 @@
+import os
+from snowflake.snowpark import Session
+from sqlalchemy import create_engine
+import pandas as pd
+from cryptography.hazmat.backends import default_backend
+from cryptography.hazmat.primitives import serialization
+import base64
+from spellbook.utils import load_and_parse_config, get_wizard
+
+
+# Needs a very specific pip install
+# pip install "snowflake-connector-python[pandas]"
+
+
+def get_db_config(db_name):
+    # load the configuration
+    try:
+        config = load_and_parse_config(configurations='databases')
+    except FileNotFoundError:
+        print("Config file not found. Please ensure 'spellbook_config.yaml' exists.")
+        config = None
+
+    for db in config['databases']:
+        if db['name'] == db_name:
+            return db
+    raise ValueError(f"Database configuration for '{db_name}' not found.")
+
+
+def snowflake_connect(db_name, **kwargs):
+    """
+    Create a Snowflake connection using credentials from the config file or environment variables.
+    :param db_name: The name of the database as defined in the config file.
+    :return: Snowpark session object.
+    """
+    db_config = get_db_config(db_name, **kwargs)  # Fetch database config from the config file
+
+    # Determine authentication method
+    use_private_key = db_config.get('private_key') or os.getenv('SNOW_PK')
+
+    try:
+        if use_private_key:
+            # Private key authentication
+            private_key = db_config.get('private_key')
+            passphrase = db_config.get('private_key_passphrase')
+
+            # Decode and load the private key
+            p_key = serialization.load_pem_private_key(
+                base64.b64decode(private_key),
+                password=passphrase.encode('ascii') if passphrase else None,
+                backend=default_backend()
+            )
+            pkb = p_key.private_bytes(
+                encoding=serialization.Encoding.DER,
+                format=serialization.PrivateFormat.PKCS8,
+                encryption_algorithm=serialization.NoEncryption()
+            )
+
+            session = Session.builder.configs({
+                'account': db_config['account'],
+                'user': db_config['user'],
+                'private_key': pkb,
+                'role': db_config['role'],
+                'warehouse': db_config['warehouse'],
+                'database': db_config['database'],
+                'schema': db_config.get('schema', 'public')
+            }).create()
+        else:
+            # Username/password authentication
+            session = Session.builder.configs({
+                'account': db_config['account'],
+                'user': db_config['user'],
+                'password': db_config.get('password'),
+                'role': db_config['role'],
+                'warehouse': db_config['warehouse'],
+                'database': db_config['database'],
+                'schema': db_config.get('schema', 'public')
+            }).create()
+
+        return session
+    except Exception as e:
+        print(f"An error occurred creating the Snowflake session: {e}")
+        return None
+
+
+def mysql_connect(db_name, **kwargs):
+    db_config = get_db_config(db_name, **kwargs)
+    try:
+        connection_string = (
+            f"mysql+mysqlconnector://{db_config['user']}:{db_config['password']}"
+            f"@{db_config['host']}:{db_config.get('port', 3306)}/{db_config['database']}"
+        )
+        engine = create_engine(connection_string)
+        con = engine.connect()
+        return con
+    except Exception as e:
+        print(f"An error occurred creating the MySQL connection: {e}")
+        return None
+
+
+def read_mysql(db_name, query):
+    """
+    Read data from a MySQL database into a Pandas DataFrame.
+    :param db_name: Name of the database as defined in the config file.
+    :param query: SQL query to execute.
+    :return:
+    """
+    con = mysql_connect(db_name)
+    if con is None:
+        return pd.DataFrame()
+    try:
+        df = pd.read_sql(query, con)
+        df.columns = df.columns.str.lower()
+        return df
+    except Exception as e:
+        print(f"An error occurred reading from MySQL: {e}")
+        return pd.DataFrame()
+    finally:
+        con.close()
+
+
+def execute_mysql(query, dbname):
+    """
+    Execute a query on a MySQL database.
+    :param query: SQL query to execute.
+    :param dbname: Database name as defined in the config file.
+    :return:
+    """
+    try:
+        # Establish a connection and run the query
+        con = mysql_connect(dbname)
+        mycursor = con.connection.cursor()
+        mycursor.execute(query)
+    except Exception as e:
+        # Handle errors
+        print('An error was encountered executing mysql, ', e)
+    finally:
+        con.close()
+
+
+def execute_snowflake(db_name, query):
+    """
+    Execute a query on Snowflake using Snowpark.
+    :param query: SQL query to execute.
+    :param db_name: Database name as defined in the config file.
+    """
+    try:
+        # Establish session
+        session = snowflake_connect(db_name)
+        if not session:
+            print("Failed to connect to Snowflake.")
+            return
+
+        # Execute query
+        session.sql(query).collect()
+        print("Query executed successfully.")
+
+    except Exception as e:
+        print(f"An error occurred executing in Snowflake: {e}")
+
+    finally:
+        if session:
+            session.close()
+
+
+def read_snowflake(db_name, query):
+    """
+    Fetch data from Snowflake into a Pandas DataFrame using Snowpark.
+    :param db_name: Database name as defined in the config file.
+    :param query: SQL query to fetch data.
+    :return: Pandas DataFrame.
+    """
+    try:
+        # Establish session
+        session = snowflake_connect(db_name)
+        if not session:
+            print("Failed to connect to Snowflake.")
+            return pd.DataFrame()
+
+        # Execute query and fetch data
+        df = session.sql(query).to_pandas()
+        df.columns = df.columns.str.lower()  # Normalize column names
+        return df
+
+    except Exception as e:
+        print(f"An error occurred reading from Snowflake: {e}")
+        return pd.DataFrame()
+
+    finally:
+        if session:
+            session.close()
+
+
+def write_data(db_name, schema, df, table_name, overwrite=True, chunk_size=1000, **kwargs):
+    """
+    Write a Pandas DataFrame to a Snowflake table using Snowpark.
+    :param db_name: Database name as defined in the config file.
+    :param schema: Schema where the table exists.
+    :param df: Pandas DataFrame to write.
+    :param table_name: Table name to write to.
+    :param overwrite: Whether to overwrite the table if it exists.
+    """
+    try:
+        # Establish session
+        session = snowflake_connect(db_name)
+        if not session:
+            print("Failed to connect to Snowflake.")
+            return
+
+        # Write DataFrame to Snowflake
+        session.write_pandas(
+            df=df,
+            schema=schema,
+            table_name=table_name,
+            auto_create_table=True,
+            overwrite=overwrite,
+            quote_identifiers=False,
+            chunk_size=chunk_size,
+            **kwargs
+        )
+        print(f"Data written successfully to {schema}.{table_name}.")
+
+    except Exception as e:
+        print(f"An error occurred writing to Snowflake: {e}")
+
+    finally:
+        if session:
+            session.close()
+
+
+def get_data(db_name, query, **kwargs):
+    """
+    Get data from a database
+    :param db_name:  The name of the database as defined in the config file.
+    :param query: SQL query to execute.
+    :return: Returns a pandas dataframe
+    """
+    db_config = get_db_config(db_name, **kwargs)
+    # Call the correct database read function
+    if db_config['type'] == 'snowflake':
+        print(get_wizard())
+        df = read_snowflake(db_name, query)
+    elif db_config['type'] == 'mysql':
+        print(get_wizard())
+        df = read_mysql(db_name, query)
+    else:
+        print('Valid database types are, snowflake and mysql')
+    return df
+
+
+def run_sql(db_name, query, **kwargs):
+    """
+    Run a SQL query on a database
+    :param db_name:  The name of the database as defined in the config file.
+    :param query:  SQL query to execute.
+    :return: None
+    """
+    db_config = get_db_config(db_name, **kwargs)
+    # Call the correct database run function
+    if db_config['type'] == 'snowflake':
+        print(get_wizard())
+        execute_snowflake(db_name, query)
+    elif db_config['type'] == 'mysql':
+        print(get_wizard())
+        execute_mysql(db_name, query)
+    else:
+        print('Valid database types are, snowflake and mysql')