Skip to main content

A simple package to make your life easier.

Project description

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

  • 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.

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:
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 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:

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

Documentation

For detailed documentation on how to use Spellbook, please refer to the Documentation folder in the repository.
Functionality:

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 file for more details.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fullscript_spellbook-2.1.5.tar.gz (28.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

fullscript_spellbook-2.1.5-py3-none-any.whl (20.9 kB view details)

Uploaded Python 3

File details

Details for the file fullscript_spellbook-2.1.5.tar.gz.

File metadata

  • Download URL: fullscript_spellbook-2.1.5.tar.gz
  • Upload date:
  • Size: 28.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.11.9

File hashes

Hashes for fullscript_spellbook-2.1.5.tar.gz
Algorithm Hash digest
SHA256 00b3bc4b3567338987683883e66ae7db9e92545dc1ba5ea2d3973f839062ca76
MD5 a53800d56b8dee78841bcf0dc7b75e3e
BLAKE2b-256 7f4711149e422018c796ef3525eaf71521c8e016f361bbcb4b212c9c10c217c1

See more details on using hashes here.

File details

Details for the file fullscript_spellbook-2.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for fullscript_spellbook-2.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 59033484eb264ce23b226135d83b2d3b205acab2488097c7f96400cb45578a9d
MD5 404318bceff38d065c07853be582fe94
BLAKE2b-256 4ee66ce070fd1b9803d858bcf7a9c8a84360ae48df66543810b9dda08276b224

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page