fullscript.spellbook 2.1.7__tar.gz → 3.0.0__tar.gz

fullscript_spellbook-3.0.0/.gitignore

@@ -0,0 +1,9 @@
+*.whl
+*.egg-info
+*.tar.gz
+__pycache__/
+.pytest_cache/
+.idea/
+venv/
+/.junie/
+.DS_Store

fullscript_spellbook-3.0.0/AGENTS.md

@@ -0,0 +1,98 @@
+# Working on Spellbook
+
+Notes for anyone - person or coding agent - changing this package. This file covers the
+things that are not obvious from reading the code.
+
+## What this package is
+
+A thin, friendly wrapper over Snowflake, MySQL, Google Sheets, Google Drive and some
+statistics helpers, published publicly to PyPI as `fullscript.spellbook`.
+
+**It is a public package.** Never commit Fullscript hostnames, database names, RDS instance
+identifiers, usernames or internal URLs - not in code, examples, docs or tests. Use
+placeholders (`${MYSQL_HOST}`, `your_rds_instance_name`) instead.
+
+## Running the tests
+
+```bash
+pip install -e '.[test]'
+pytest
+```
+
+Tests mock the database and `subprocess`, so they need no network and no credentials.
+`tests/test_db_magic.py` covers connections and auth, `tests/test_utils.py` covers config
+loading. Testing against a real database needs AWS SSO, which no automated run can do.
+
+## Versioning
+
+The version is **not** in a file. `setuptools_scm` derives it from git tags, so releasing
+means tagging:
+
+```bash
+git tag 3.0.0 && git push origin main --tags
+```
+
+Pushing a tag triggers `.gitlab-ci.yml`, which publishes to both the internal registry and
+public PyPI. Do not tag unless you intend to publish.
+
+## Conventions worth keeping
+
+**Errors raise, they do not return empty.** Every failure path raises a subclass of
+`SpellbookError` from `spellbook/exceptions.py`. Returning `pd.DataFrame()` or `None` on
+failure is the thing this package deliberately moved away from: a caller cannot tell
+"matched no rows" from "never ran", which produces confidently wrong analysis. An empty
+DataFrame must only ever mean zero rows.
+
+**Decorative output goes to stderr, never stdout.** The wizard ASCII art is charm, not
+data. `utils.show_wizard()` honours `SPELLBOOK_QUIET=1`; set that when calling Spellbook
+from a script or agent. Use `logging` for diagnostics rather than `print`.
+
+**Function signatures are `(db_name, query)`, in that order.** `execute_mysql` once took
+`(query, dbname)`, which silently broke every `run_sql` call against MySQL. Keep the order
+and the `db_name` spelling consistent across every function.
+
+**Bind parameters in catalogue queries.** `list_tables` and `describe_table` pass values
+through SQLAlchemy parameters so a `%` or a quote in user input cannot reshape the query.
+`preview_table` cannot bind a table name, so it validates it against a strict identifier
+pattern instead.
+
+## Traps that have cost time before
+
+**Config file precedence.** `utils.find_config_file()` prefers `spellbook_config.yaml` in
+the *current working directory* over the one in your home directory. Running anything from
+this repository picks up the placeholder example config, not your real one. If a connection
+fails with odd credentials, check which file was loaded.
+
+**Two MySQL drivers.** Password auth uses `mysql+mysqlconnector`; AWS RDS IAM auth uses
+`mysql+pymysql`, because only pymysql completes the IAM token handshake. They are not
+interchangeable:
+
+- pymysql substitutes parameters whenever `args is not None`, and pandas passes an empty
+  tuple, so a literal `%` in `like '%value%'` is read as a format character and raises.
+  mysql-connector guards on `if params:` instead. `db_magic._iam_cursor_class()` normalises
+  empty parameters to `None` so both drivers behave the same. Do not remove it without a
+  test that runs a `like '%...%'` query.
+- An empty `ssl` dict makes TLS merely *preferred* in pymysql. The dict passed must be
+  truthy for TLS to be required.
+
+**RDS IAM specifics.** Tokens expire in about 15 minutes, so they are fetched per
+connection and never cached. `rx rds password` takes the *RDS instance* name, which usually
+differs from the config alias - hence the optional `rds_db_name` field. The token is URL
+shaped and must be `quote_plus`-escaped into the connection string.
+
+**`iam_auth` is internal only.** It shells out to `rx`, which is Fullscript internal
+tooling, so the feature cannot work for public users of this package. Keep password auth
+working and keep the docs honest about the limitation.
+
+## Repository layout
+
+| Path | Purpose |
+| --- | --- |
+| `spellbook/db_magic.py` | Snowflake and MySQL connections, queries, schema helpers |
+| `spellbook/exceptions.py` | The `SpellbookError` hierarchy |
+| `spellbook/utils.py` | Config loading, env substitution, wizards, SQL file loading |
+| `spellbook/sheet_magic.py` | Google Sheets |
+| `spellbook/drive_magic.py` | Google Drive |
+| `spellbook/stats_magic.py` | Statistical tests |
+| `spellbook_config.yaml` | **Example** config, published - placeholders only |
+| `documentation/` | User-facing docs per module |

fullscript_spellbook-3.0.0/CLAUDE.md

@@ -0,0 +1 @@
+See [AGENTS.md](AGENTS.md) for how to work on this package.

{fullscript_spellbook-2.1.7 → fullscript_spellbook-3.0.0}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: fullscript.spellbook
-Version: 2.1.7
+Version: 3.0.0
 Summary: A simple package to make your life easier.
-Author-email: Thomas Edwards <thomas.edwards@fullscript.com>, Gui Chagas <gui.chagas@fullscript.com>, David King <david.king@fullscript.com>, Meinhard Mare <meinhard.mare@fullscript.com>, Karsten Melchers <karsten.melchers@fullscript.com>
+Author-email: Meinhard Mare <meinhard.mare@fullscript.com>, Thomas Edwards <thomas.edwards@fullscript.com>, Gui Chagas <gui.chagas@fullscript.com>, David King <david.king@fullscript.com>, Karsten Melchers <karsten.melchers@fullscript.com>
 License: MIT
 Project-URL: homepage, https://github.com/Fullscript/spellbook
 Requires-Python: <3.12,>=3.10
@@ -46,6 +46,7 @@ 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: PyMySQL==1.2.3
 Requires-Dist: python-dateutil==2.9.0.post0
 Requires-Dist: pytz==2024.2
 Requires-Dist: PyYAML==6.0.2
@@ -116,6 +117,8 @@ 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"
+Provides-Extra: test
+Requires-Dist: pytest==8.3.4; extra == "test"
 Dynamic: license-file
 
 # Spellbook
@@ -186,6 +189,16 @@ databases:
     database: snowflake_database
     schema: snowflake_schema
 
+  # MySQL Database Connection using AWS RDS IAM authentication (no stored password).
+  # Fullscript internal only: requires the `rx` CLI. See documentation/db_magic.md.
+  - name: alias_of_your_connection
+    type: mysql
+    host: your_host.rds.amazonaws.com
+    port: 3306
+    user: ${DB_USER}
+    iam_auth: true
+    database: ${MYSQL_DATABASE}
+
 google_accounts:
   # Google Sheets Service Account 1
   - name: google_sheets_service_account_1

{fullscript_spellbook-2.1.7 → fullscript_spellbook-3.0.0}/README.md

@@ -66,6 +66,16 @@ databases:
     database: snowflake_database
     schema: snowflake_schema
 
+  # MySQL Database Connection using AWS RDS IAM authentication (no stored password).
+  # Fullscript internal only: requires the `rx` CLI. See documentation/db_magic.md.
+  - name: alias_of_your_connection
+    type: mysql
+    host: your_host.rds.amazonaws.com
+    port: 3306
+    user: ${DB_USER}
+    iam_auth: true
+    database: ${MYSQL_DATABASE}
+
 google_accounts:
   # Google Sheets Service Account 1
   - name: google_sheets_service_account_1

fullscript_spellbook-3.0.0/documentation/db_magic.md

@@ -0,0 +1,254 @@
+A magical wrapper to perform work with databases.
+
+
+##### Key Features
+* **Unified Interface**: Abstracts the complexities of connecting and interacting with Snowflake and MySQL databases.
+* **Seamless Data Handling**: Fetch, manipulate, and write data with Pandas DataFrames.
+* **Flexibility**: Supports secure credentials management via configuration files and environment variables.
+
+```python
+from spellbook import db_magic
+```
+
+### Error Handling
+
+Every failure raises an exception. An empty DataFrame always means "the query matched no
+rows" and never "something went wrong", so results can be trusted without extra checks.
+
+```python
+from spellbook import db_magic
+from spellbook.exceptions import SpellbookError, QueryError, DatabaseNotFoundError
+
+try:
+    df = db_magic.get_data('reporting_db', 'select * from users limit 10')
+except DatabaseNotFoundError:
+    ...  # the name is not in spellbook_config.yaml
+except QueryError:
+    ...  # the database rejected the query
+except SpellbookError:
+    ...  # anything Spellbook raises
+```
+
+| Exception | Raised when |
+| --- | --- |
+| `SpellbookError` | Base class for all of the below |
+| `ConfigError` | The config file is missing, malformed, or references an unset `${VAR}` |
+| `DatabaseNotFoundError` | No database in the config matches the requested name |
+| `AuthenticationError` | Credentials could not be obtained or were rejected |
+| `ConnectionFailedError` | The database could not be reached |
+| `QueryError` | The query was rejected or failed while running |
+
+> **Upgrading from 2.x:** these functions used to print a message and return an empty
+> DataFrame or `None` on failure. Code that inspected `df.empty` to detect *errors* now
+> needs a `try`/`except`. Code that used `df.empty` to detect *zero rows* is unaffected.
+
+### Quiet Mode
+
+Spellbook prints a wizard for company on each query. It goes to stderr, never stdout, so it
+cannot contaminate results. Set `SPELLBOOK_QUIET=1` to turn it off - recommended for
+scripts, scheduled jobs and anything driven by an AI agent.
+
+```bash
+export SPELLBOOK_QUIET=1
+```
+
+### MySQL Authentication
+
+MySQL connections support two authentication methods, chosen per database in `spellbook_config.yaml`.
+
+**Password authentication** is the default and needs no changes to an existing config:
+
+```yaml
+- name: legacy_mysql
+  type: mysql
+  host: your_host
+  port: 3306
+  user: mysql_user_name
+  password: ${MYSQL_PASSWORD}
+  database: mysql_database
+```
+
+**AWS RDS IAM authentication** stores no password at all. Add `iam_auth: true` and Spellbook
+calls `rx rds password <rds_db_name>` for a temporary token each time it connects, because the
+tokens expire after about 15 minutes:
+
+> **Internal use only.** `iam_auth` depends on the `rx` CLI, which is Fullscript internal
+> tooling and is not publicly available. Password authentication is the only MySQL option
+> outside Fullscript, and it remains fully supported.
+
+```yaml
+- name: reporting_db
+  type: mysql
+  host: ${MYSQL_HOST} # e.g. your-instance.abc123.us-east-1.rds.amazonaws.com
+  port: 3306
+  user: ${DB_USER}
+  iam_auth: true
+  rds_db_name: your_rds_instance_name # Optional, defaults to the value of `name`
+  database: ${MYSQL_DATABASE}
+```
+
+| Field | Required | Notes |
+| --- | --- | --- |
+| `iam_auth` | No | `true` switches the database to IAM tokens. Omitting it keeps password authentication. |
+| `user` | Yes | Your IAM database user. |
+| `rds_db_name` | No | The remote database as named by `rx rds list`. Defaults to `name`, so set it whenever your config alias differs from the RDS name. |
+| `ssl_ca` | No | Not needed in normal use; see below. |
+| `password` | No | Ignored when `iam_auth` is true. |
+
+Requirements for the IAM path:
+* The `rx` CLI must be installed and on your `PATH`.
+* You must be signed in to AWS. If a connection hangs or fails on authentication, run
+  `rx rds password <rds_db_name>` in a terminal once to complete the AWS SSO prompt.
+* IAM connections use the `pymysql` driver (installed with Spellbook). Password connections
+  continue to use `mysql-connector`.
+
+##### A note on TLS and `ssl_ca`
+
+AWS requires TLS for IAM authentication, so Spellbook always negotiates an encrypted
+connection. You do **not** need to set `ssl_ca` — leave it out and you get TLS without
+verifying which server you reached, which is the normal setup.
+
+Set `ssl_ca` only if you also want the server certificate verified. If you do:
+* Point it at the [AWS RDS CA bundle](https://truststore.pki.rds.amazonaws.com/global/global-bundle.pem).
+  Your operating system's bundle will not work, because RDS certificates do not chain to a
+  publicly trusted root; using it fails with `CERTIFICATE_VERIFY_FAILED`.
+* Use the instance's own RDS endpoint as `host`. Verification also checks the hostname, so a
+  CNAME that points at the instance is likely to be rejected even with the right bundle.
+
+### Methods Overview
+
+
+##### get_data(db_name, query)
+
+Fetches data from a specified database and returns it as a Pandas DataFrame. This method abstracts the connection and retrieval process for both Snowflake and MySQL databases, allowing you to focus on the SQL query.
+
+Parameters:
+* `db_name` (str): The database name defined in the configuration file.
+* `query` (str): The SQL query to execute.
+
+Returns:
+* A Pandas DataFrame containing the result of the query.
+
+```python
+# Fetch data from Snowflake
+# Option 1:
+query = "SELECT * FROM my_table LIMIT 10;"
+df = db_magic.get_data("snowflake_db", query)
+
+# Option 2:
+df = db_magic.get_data("snowflake_db", 'my_sql_query.sql')
+
+# Option 3:
+df = db_magic.get_data("snowflake_db", 'user/project/my_query.sql')
+
+
+# Fetch data from MySQL
+query = "SELECT * FROM users WHERE is_active = 1;"
+df = db_magic.get_data("mysql_db", query)
+
+# Display results
+print(df.head())
+```
+
+##### write_data(db_name, schema, df, table_name, overwrite=True, chunk_size=1000, **kwargs)
+
+Writes a Pandas DataFrame to a table in Snowflake. It supports creating tables automatically and overwriting existing tables.
+
+Parameters:
+* `db_name` (str): The database name defined in the configuration file.
+* `schema` (str): The schema where the table is located.
+* `df` (Pandas DataFrame): The data to write.
+* `table_name` (str): The name of the destination table.
+* `overwrite` (bool): Whether to overwrite the table if it exists (default: True).
+* `chunk_size` (int): Number of rows to write per chunk (default: 1000).
+
+```python
+import pandas as pd
+
+# Create a sample DataFrame
+data = {"id": [1, 2, 3], "name": ["Alice", "Bob", "Charlie"]}
+df = pd.DataFrame(data)
+
+# Write data to Snowflake
+db_magic.write_data("snowflake_db", "my_schema", df, "my_table", overwrite=True)
+```
+
+##### run_sql(db_name, query)
+
+Executes a SQL query directly on a specified database without returning results. Ideal for operations like creating tables, updating rows, or running stored procedures.
+
+Parameters:
+* `db_name` (str): The database name defined in the configuration file.
+* `query` (str): The SQL query to execute.
+
+Returns:
+* `None`
+
+```python
+
+# Execute SQL in Snowflake
+create_table_query = """
+CREATE TABLE my_table (
+    id INT,
+    name STRING
+);
+"""
+db_magic.run_sql("snowflake_db", create_table_query)
+
+# Execute SQL in MySQL
+update_query = "UPDATE users SET is_active = 1 WHERE last_login > '2024-01-01';"
+db_magic.run_sql("mysql_db", update_query)
+
+print("SQL executed successfully!")
+```
+
+### Exploring a database
+
+These helpers answer "what is in here?" without hand-writing `information_schema` queries.
+They are useful interactively, and they are what an AI agent needs before it can write a
+sensible query.
+
+##### list_databases()
+
+Lists the databases in your configuration file, with no credentials included.
+
+```python
+db_magic.list_databases()
+#            name     type        database  iam_auth
+# 0  reporting_db    mysql  mysql_database      True
+```
+
+##### list_tables(db_name, pattern=None)
+
+Lists the tables in a database, optionally filtered by a case-insensitive substring.
+
+```python
+db_magic.list_tables("mysql_db")
+db_magic.list_tables("mysql_db", pattern="order")
+```
+
+The pattern is passed as a bound parameter, so `%` and quotes in it are treated as literal
+text rather than changing the query.
+
+##### describe_table(db_name, table)
+
+Returns one row per column, with its type, nullability and default. Raises `QueryError` if
+the table does not exist.
+
+```python
+db_magic.describe_table("mysql_db", "users")
+#   column_name data_type is_nullable column_default
+# 0          id    bigint          NO           None
+# 1        name   varchar         YES           None
+```
+
+##### preview_table(db_name, table, limit=10)
+
+Reads the first few rows of a table.
+
+```python
+db_magic.preview_table("mysql_db", "users", limit=5)
+```
+
+`table` must be a plain identifier - letters, digits, underscores, dots or dollar signs -
+because a table name cannot be passed as a bound parameter.

{fullscript_spellbook-2.1.7 → fullscript_spellbook-3.0.0}/fullscript.spellbook.egg-info/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: fullscript.spellbook
-Version: 2.1.7
+Version: 3.0.0
 Summary: A simple package to make your life easier.
-Author-email: Thomas Edwards <thomas.edwards@fullscript.com>, Gui Chagas <gui.chagas@fullscript.com>, David King <david.king@fullscript.com>, Meinhard Mare <meinhard.mare@fullscript.com>, Karsten Melchers <karsten.melchers@fullscript.com>
+Author-email: Meinhard Mare <meinhard.mare@fullscript.com>, Thomas Edwards <thomas.edwards@fullscript.com>, Gui Chagas <gui.chagas@fullscript.com>, David King <david.king@fullscript.com>, Karsten Melchers <karsten.melchers@fullscript.com>
 License: MIT
 Project-URL: homepage, https://github.com/Fullscript/spellbook
 Requires-Python: <3.12,>=3.10
@@ -46,6 +46,7 @@ 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: PyMySQL==1.2.3
 Requires-Dist: python-dateutil==2.9.0.post0
 Requires-Dist: pytz==2024.2
 Requires-Dist: PyYAML==6.0.2
@@ -116,6 +117,8 @@ 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"
+Provides-Extra: test
+Requires-Dist: pytest==8.3.4; extra == "test"
 Dynamic: license-file
 
 # Spellbook
@@ -186,6 +189,16 @@ databases:
     database: snowflake_database
     schema: snowflake_schema
 
+  # MySQL Database Connection using AWS RDS IAM authentication (no stored password).
+  # Fullscript internal only: requires the `rx` CLI. See documentation/db_magic.md.
+  - name: alias_of_your_connection
+    type: mysql
+    host: your_host.rds.amazonaws.com
+    port: 3306
+    user: ${DB_USER}
+    iam_auth: true
+    database: ${MYSQL_DATABASE}
+
 google_accounts:
   # Google Sheets Service Account 1
   - name: google_sheets_service_account_1

{fullscript_spellbook-2.1.7 → fullscript_spellbook-3.0.0}/fullscript.spellbook.egg-info/SOURCES.txt

@@ -1,7 +1,8 @@
-.DS_Store
 .gitignore
 .gitlab-ci.yml
 .python-version
+AGENTS.md
+CLAUDE.md
 LICENSE
 MANIFEST.in
 README.md
@@ -17,11 +18,14 @@ fullscript.spellbook.egg-info/PKG-INFO
 fullscript.spellbook.egg-info/SOURCES.txt
 fullscript.spellbook.egg-info/dependency_links.txt
 fullscript.spellbook.egg-info/requires.txt
+fullscript.spellbook.egg-info/scm_file_list.json
+fullscript.spellbook.egg-info/scm_version.json
 fullscript.spellbook.egg-info/top_level.txt
-spellbook/.DS_Store
 spellbook/__init__.py
 spellbook/db_magic.py
 spellbook/drive_magic.py
+spellbook/exceptions.py
+spellbook/py.typed
 spellbook/sheet_magic.py
 spellbook/stats_magic.py
 spellbook/utils.py
@@ -37,4 +41,6 @@ spellbook/wizards/wizard5.txt
 spellbook/wizards/wizard6.txt
 spellbook/wizards/wizard7.txt
 spellbook/wizards/wizard8.txt
-spellbook/wizards/wizard9.txt
+spellbook/wizards/wizard9.txt
+tests/test_db_magic.py
+tests/test_utils.py

{fullscript_spellbook-2.1.7 → fullscript_spellbook-3.0.0}/fullscript.spellbook.egg-info/requires.txt

@@ -36,6 +36,7 @@ pycparser==2.22
 Pygments==2.18.0
 PyJWT==2.9.0
 pyOpenSSL==24.2.1
+PyMySQL==1.2.3
 python-dateutil==2.9.0.post0
 pytz==2024.2
 PyYAML==6.0.2
@@ -109,3 +110,6 @@ scipy==1.14.1
 seaborn==0.13.2
 six==1.16.0
 statsmodels==0.14.4
+
+[test]
+pytest==8.3.4

fullscript_spellbook-3.0.0/fullscript.spellbook.egg-info/scm_file_list.json

@@ -0,0 +1,43 @@
+{
+  "files": [
+    ".gitignore",
+    ".gitlab-ci.yml",
+    ".python-version",
+    "AGENTS.md",
+    "CLAUDE.md",
+    "LICENSE",
+    "MANIFEST.in",
+    "README.md",
+    "documentation/db_magic.md",
+    "documentation/drive_magic.md",
+    "documentation/sheet_magic.md",
+    "documentation/snowflake_key_pair_setup.md",
+    "documentation/stats_magic.md",
+    "pyproject.toml",
+    "requirements.txt",
+    "spellbook/__init__.py",
+    "spellbook/db_magic.py",
+    "spellbook/drive_magic.py",
+    "spellbook/exceptions.py",
+    "spellbook/py.typed",
+    "spellbook/sheet_magic.py",
+    "spellbook/stats_magic.py",
+    "spellbook/utils.py",
+    "spellbook/wizards/__init__.py",
+    "spellbook/wizards/wizard1.txt",
+    "spellbook/wizards/wizard10.txt",
+    "spellbook/wizards/wizard11.txt",
+    "spellbook/wizards/wizard12.txt",
+    "spellbook/wizards/wizard2.txt",
+    "spellbook/wizards/wizard3.txt",
+    "spellbook/wizards/wizard4.txt",
+    "spellbook/wizards/wizard5.txt",
+    "spellbook/wizards/wizard6.txt",
+    "spellbook/wizards/wizard7.txt",
+    "spellbook/wizards/wizard8.txt",
+    "spellbook/wizards/wizard9.txt",
+    "spellbook_config.yaml",
+    "tests/test_db_magic.py",
+    "tests/test_utils.py"
+  ]
+}

fullscript_spellbook-3.0.0/fullscript.spellbook.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "3.0.0",
+  "distance": 0,
+  "node": "g5c9c10546f95ea303f36c2cc2e273cf241b92215",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-22"
+}

{fullscript_spellbook-2.1.7 → fullscript_spellbook-3.0.0}/pyproject.toml

@@ -10,10 +10,10 @@ readme = "README.md"
 license = {text = "MIT"}
 requires-python = ">=3.10, <3.12"
 authors = [
+    {name = "Meinhard Mare", email = "meinhard.mare@fullscript.com"},
     {name = "Thomas Edwards", email = "thomas.edwards@fullscript.com"},
     {name = "Gui Chagas", email = "gui.chagas@fullscript.com"},
     {name = "David King", email = "david.king@fullscript.com"},
-    {name = "Meinhard Mare", email = "meinhard.mare@fullscript.com"},
     {name = "Karsten Melchers", email = "karsten.melchers@fullscript.com"}
 ]
 urls = {homepage = "https://github.com/Fullscript/spellbook"}
@@ -56,6 +56,7 @@ dependencies = [
     "Pygments==2.18.0",
     "PyJWT==2.9.0",
     "pyOpenSSL==24.2.1",
+    "PyMySQL==1.2.3",
     "python-dateutil==2.9.0.post0",
     "pytz==2024.2",
     "PyYAML==6.0.2",
@@ -133,11 +134,18 @@ statsmagic = [
     "statsmodels==0.14.4"
 ]
 
+test = [
+    "pytest==8.3.4"
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+
 [tool.setuptools.packages.find]
 where = ["."]
 include = ["spellbook"]
 
 [tool.setuptools.package-data]
-"spellbook" = ["wizards/*.txt"]
+"spellbook" = ["wizards/*.txt", "py.typed"]
 
 [tool.setuptools_scm]

fullscript_spellbook-3.0.0/spellbook/__init__.py

@@ -0,0 +1,19 @@
+"""Spellbook: connect to databases, spreadsheets and Drive, and run analyses."""
+
+from spellbook.exceptions import (
+    AuthenticationError,
+    ConfigError,
+    ConnectionFailedError,
+    DatabaseNotFoundError,
+    QueryError,
+    SpellbookError,
+)
+
+__all__ = [
+    'SpellbookError',
+    'ConfigError',
+    'DatabaseNotFoundError',
+    'AuthenticationError',
+    'ConnectionFailedError',
+    'QueryError',
+]