squirrels 0.5.0b3__py3-none-any.whl → 0.6.0.post0__py3-none-any.whl

squirrels/types.py

@@ -1,11 +1,18 @@
+from ._api_server import FastAPIComponents
+
 from ._data_sources import DataSource
 
 from ._parameter_options import ParameterOption
 
 from ._parameters import Parameter, TextValue
 
-from ._auth import BaseUser
-
 from ._dataset_types import DatasetMetadata, DatasetResult
 
-from ._dashboard_types import Dashboard
+from ._dashboards import Dashboard
+
+from ._parameter_configs import ParameterConfigBase
+
+__all__ = [
+    "FastAPIComponents", "DataSource", "ParameterOption", "Parameter", "TextValue", 
+    "DatasetMetadata", "DatasetResult", "Dashboard", "ParameterConfigBase"
+]

squirrels-0.6.0.post0.dist-info/METADATA

@@ -0,0 +1,148 @@
+Metadata-Version: 2.4
+Name: squirrels
+Version: 0.6.0.post0
+Summary: Squirrels - SDK for Data Analytics API & MCP Server
+Project-URL: Homepage, https://docs.pysquirrels.com
+Project-URL: Repository, https://github.com/squirrels-analytics/squirrels
+Project-URL: Documentation, https://docs.pysquirrels.com
+Author-email: Tim Huang <timhuang95@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: authlib>=1.5.2
+Requires-Dist: bcrypt>=4.0.1
+Requires-Dist: cachetools>=5.3.2
+Requires-Dist: duckdb>=1.4.0
+Requires-Dist: fastapi>=0.112.1
+Requires-Dist: gitpython>=3.1.41
+Requires-Dist: inquirer>=3.2.1
+Requires-Dist: itsdangerous>=2.2.0
+Requires-Dist: jinja2>=3.1.3
+Requires-Dist: libpass>=1.9.0
+Requires-Dist: matplotlib>=3.8.3
+Requires-Dist: mcp>=1.24.0
+Requires-Dist: pandas>=2.1.4
+Requires-Dist: polars>=1.14.0
+Requires-Dist: pyarrow>=19.0.1
+Requires-Dist: pydantic>=2.8.2
+Requires-Dist: pyjwt>=2.8.0
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: python-multipart>=0.0.9
+Requires-Dist: pyyaml>=6.0.1
+Requires-Dist: requests>=2.32.5
+Requires-Dist: sqlalchemy>=2.0.25
+Requires-Dist: sqlglot>=26.12.1
+Requires-Dist: update-checker>=0.18.0
+Requires-Dist: uvicorn>=0.30.6
+Description-Content-Type: text/markdown
+
+# Squirrels
+
+Squirrels is an API framework that lets you create REST APIs for dynamic data analytics!
+
+**Documentation**: <a href="https://docs.pysquirrels.com" target="_blank">https://docs.pysquirrels.com</a>
+
+**Source Code**: <a href="https://github.com/squirrels-analytics/squirrels" target="_blank">https://github.com/squirrels-analytics/squirrels</a>
+
+## Table of Contents
+
+- [Main Features](#main-features)
+- [License](#license)
+- [Contributing to Squirrels](#contributing-to-squirrels)
+    - [Setup](#setup)
+    - [Testing](#testing)
+    - [Project Structure](#project-structure)
+
+## Main Features
+
+Here are a few of the things that Squirrels can do:
+
+- Connect to any database by specifying its SQLAlchemy url (in `squirrels.yml`) or by using its native connector library in python (in `connections.py`).
+- Configure API routes for datasets (in `squirrels.yml`) without writing code.
+- Configure parameter widgets (types include single-select, multi-select, date, number, etc.) for your datasets (in `parameters.py`).
+- Use SQL templates (templated with Jinja, like dbt) or python functions (that return a Python dataframe in polars or pandas) to define dynamic query logic based on parameter selections.
+- Query multiple databases and join the results together in a final view in one API endpoint/dataset!
+- Test your API endpoints with Squirrels Studio or by a command line that generates rendered sql queries and results as files (for a given set of parameter selections).
+- Define User model (in `user.py`) and authorize privacy scope per dataset (in `squirrels.yml`). The user's attributes can even be used in your query logic!
+- Serve dataset metadata and results to AI agents via MCP (Model Context Protocol)
+
+## Quick Start
+
+In a new virtual environment, install `squirrels`. Then, in your project directory, activate the virtual environment and run the following commands:
+
+```bash
+sqrl new --use-defaults --curr-dir
+sqrl build
+```
+
+To run the API server, simply run:
+
+```bash
+sqrl run
+```
+
+## License
+
+Squirrels is released under the Apache 2.0 license.
+
+See the file LICENSE for more details.
+
+## Contributing to Squirrels
+
+The sections below describe how to set up your local environment for Squirrels development and run unit tests. A high level overview of the project structure is also provided.
+
+### Setup
+
+This project requires the python package manager `uv` with Python 3.10 or above. Information on setting up uv can be found at: https://docs.astral.sh/uv/getting-started/installation/.
+
+Then, to install all dependencies in a virtual environment, run:
+
+```bash
+uv sync -p 3.10
+```
+
+And activate the virtual environment with:
+
+```bash
+source .venv/bin/activate
+```
+
+To confirm that the setup worked, run the following to show the help page for all Squirrels CLI commands:
+
+```bash
+sqrl -h
+```
+
+### Project Structure
+
+From the root of the git repo, the source code can be found in the `squirrels` folder and unit tests can be found in the `tests` folder.
+
+The documentation contents are in the `docs/` folder and are built with Mintlify.
+
+To understand what a specific Squirrels command is doing, start from the `_command_line.py` file as your entry point.
+
+The library version is maintained in both the `pyproject.toml` and the `squirrels/_version.py` files.
+
+### Testing
+
+Run `uv run pytest`. Or if you have the virtual environment activated, simply run `pytest`.
+
+### Documentation
+
+Install the [Mintlify CLI](https://www.npmjs.com/package/mint) to preview your documentation changes locally. To install, use the following command:
+
+```
+npm i -g mint
+```
+
+Run the following command in the `docs/` folder, where the `docs.json` is located:
+
+```
+mint dev
+```
+
+View your local preview at `http://localhost:3000`.

squirrels-0.6.0.post0.dist-info/RECORD

@@ -0,0 +1,101 @@
+dateutils/__init__.py,sha256=dq4VSlJ5ztaDPdvYBRAvXSyanT_CZif3I4O0YVmWfa8,277
+dateutils/_enums.py,sha256=WBrnLqta_iMMhGMEn24cCO1Vlr7bST0E8oEfAL3z0P8,373
+dateutils/_implementation.py,sha256=PVJAdNolDdTpCZXwvokKoMIZzTSNpCUvZlVLWpMeSho,15173
+dateutils/types.py,sha256=xcRwBoftQi-uHM1tlVTW5xgN84qdrqCo5tQT7A34S8Y,124
+squirrels/__init__.py,sha256=nvzVVd5yHYbpQAfyKdQGDMxZpW7wVq3uUlpg4Urc_ws,320
+squirrels/_api_server.py,sha256=wE3Wz-IfKWENrKiyC1b96ANjlG8STOplxqRe3eBhJJ0,25534
+squirrels/_auth.py,sha256=aWYZ9tmx9FSIhWfA0OYVRVL04L9CnYVX2r56DycQ2Go,34961
+squirrels/_command_line.py,sha256=gRXM1EkjRrwSdiC19BQGnlFQizdpf2LwcnP5JiUcvEU,15336
+squirrels/_compile_prompts.py,sha256=XIbRciSXak6NuDD4KedeDoUV5YSHvctQGk6HMxKchBw,5562
+squirrels/_connection_set.py,sha256=r8OXth9L3f_HUE7WU0Tjrsmu0EN3NFL_HVXDlQDCuUA,4032
+squirrels/_constants.py,sha256=317Ab7EQz1VimzGghcQw26YAFmjNg5uJ2yIqWEZqOvg,4100
+squirrels/_dashboards.py,sha256=momVodpSveuD-0HdKA9vIJTYYl0WHNfG9NxhfNQ9wmY,6004
+squirrels/_data_sources.py,sha256=BsuNcUEt9fLdLARbjzaLcf7PhPVLyHNeZuEFbKlkw6I,26445
+squirrels/_dataset_types.py,sha256=qp2z5SblubPKu2o-oiKuKJhKiyT4lAPZnsiDXUsFW2I,2959
+squirrels/_env_vars.py,sha256=gPeZL1cZ8z_hDuOdyJH2h9uIfaIu9D3_0hgs42KICxU,7966
+squirrels/_exceptions.py,sha256=-hfDZoV-JhvuNRAERTFg-5NFjr0uNk4i9ogNgJfAyyc,1171
+squirrels/_http_error_responses.py,sha256=_LFBFWL0My4E_CStDBOJs8shdu0cp5mP_2WoiH-lqW8,2004
+squirrels/_initializer.py,sha256=9isok4vJQriAPzKCHQ8sXgf50GIFSo5E5wPwl0CuXK8,14333
+squirrels/_logging.py,sha256=WgL48t0-1aLhfLU235PQ9CaE1o2LOckdZD-jfYsQc1Y,4308
+squirrels/_manifest.py,sha256=tspmREFlnl-mq0zFtrBzeAmfWph4CjUnJnMM71mxW9c,13236
+squirrels/_mcp_server.py,sha256=jl60AMxekAGlG75ij8AE-LV101TAZVxmN9YqhYVR3-s,27446
+squirrels/_model_builder.py,sha256=och7eKtde38xM-aZZ-VcSAFu8muuf0JtlELNaKIx-F4,2779
+squirrels/_model_configs.py,sha256=szDu_byDoQOdSSui9pnZfD5ZGcY_UNNwKOJqtMgbK0c,3352
+squirrels/_model_queries.py,sha256=2fl07feHtzddBpiXUWGfNBYeoN_EZ7K5mAz2Jc-vCvs,1087
+squirrels/_models.py,sha256=PXzb-j8sRlJEXmJxZmTc29SKq2obQVoyJZrMOOC2gC8,55352
+squirrels/_package_loader.py,sha256=xcIur5Z38OWd-OVjsueFstVV567zlkK9UBnLS4NawJY,1158
+squirrels/_parameter_configs.py,sha256=K7p_pIobT-gPZ99ewzLKV1aUzhnmfbGO7WjuzgjhDM8,24867
+squirrels/_parameter_options.py,sha256=HatFFPyHrZo2ct3BS-FCHPzNqcIst4dVh14SgkhhFyw,16874
+squirrels/_parameter_sets.py,sha256=uvpSL_2eeqyQECKkBMv_gyLR2vKW-n42OuecN6h1730,10345
+squirrels/_parameters.py,sha256=SQsVd7OEWFfoA21d_0uf_KD9Li2wgMNQzJMO8GhgyRw,77664
+squirrels/_project.py,sha256=VKKJj8Srp8zNrWKHNuNm5a4VW-yBt5hdmlap22zX-OU,40490
+squirrels/_py_module.py,sha256=62yfbIRrZvz8oO3wb2EHQW9SHvDpLptu36JVh50Q3YQ,4796
+squirrels/_request_context.py,sha256=5FBxIQJ_Ki0sekZC_XrzS4GIegqoJuPnalQhGBsm-kQ,964
+squirrels/_seeds.py,sha256=ROlMHhBz1xdS8mJYWPT9-zzH5KdzyCqgV_lDWNE_zEw,3311
+squirrels/_sources.py,sha256=7zXrPZtJFR-JtAWH7NS7cJbNCiY1WE5GokGPUPwcZvs,5292
+squirrels/_utils.py,sha256=12foyZTRw8rw5mj5b4E9VwHdGLEe7Tgde730jL9OMbw,18462
+squirrels/_version.py,sha256=CBY3jsC-9HCm7eZ6CKD-sYLCejqOJ1pYWPQM4LGIXcI,22
+squirrels/arguments.py,sha256=6rWDwv8jbimBUYv4peE2kEuFzOQ4jn9Tr_QXUmEj0_o,324
+squirrels/auth.py,sha256=oX5-0QT4aKiUSyImKkLtPLYoki1SVNgaU3KBQzIizP4,193
+squirrels/connections.py,sha256=FVK0se1LUAzsapPZYlWc1q6jTJ6hiU2RuYinBEvZ5a0,122
+squirrels/dashboards.py,sha256=egYWL7jV9hvyxZ0vFziQb4q3sKDLfE_TNJN5niQbzX4,98
+squirrels/data_sources.py,sha256=P3VIGWqspXLlxKUTDXc5u5eJ2yQoo4rvy9RGEb_OIbQ,347
+squirrels/parameter_options.py,sha256=5ucgTWvdwefurMrk7xiJhmRn6fbBXXOhQdH7Mbnm-1I,382
+squirrels/parameters.py,sha256=TJcsjtj0Kg0F69I5Zk7r0uDJC7p8duk3gtjXjcQPE40,366
+squirrels/types.py,sha256=kUWz-S-CmCWS5Q9zwoJyLKJ46l202uVcBOPKjegztdo,502
+squirrels/_api_routes/__init__.py,sha256=-oGMDfM5Qo7NDiwpjHt8BKVZNNZ4798-NZCJzYCUdbc,106
+squirrels/_api_routes/auth.py,sha256=em2jE0_DxwbqHFHdMr3vQNMCUqx8WXuYhRGFaf4p5Bw,17983
+squirrels/_api_routes/base.py,sha256=7ExlpxKXxGz2c6obw9gmFANYOB1nhIl48uASJf8B338,8878
+squirrels/_api_routes/dashboards.py,sha256=4pDjPXSCm8BNRci_qYQSY4mLeqEEGwuPaIFhxlrqNyw,8574
+squirrels/_api_routes/data_management.py,sha256=XzhIH1XILqwhI9gkr_b8J1c2eZTRBdM6Ht_5amUM1xs,8275
+squirrels/_api_routes/datasets.py,sha256=h19sH8No9L9Bl0frnkRGq1piqCu1p4t9b4n85uexbUo,11803
+squirrels/_api_routes/project.py,sha256=bY8jmLF3fzRl4Q3YlAndO8zWBnlY8uQ-A-tO58rF88g,16179
+squirrels/_arguments/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+squirrels/_arguments/init_time_args.py,sha256=a6oX_OwK-6SorGlyAIhR7BfMUNZcH4qQkAcYgAQ2T4I,2784
+squirrels/_arguments/run_time_args.py,sha256=X3XZ2zkRtUE2c3yarb-LlNG4UTPB-sZTr9fUp1DerDw,3884
+squirrels/_package_data/base_project/.env,sha256=gTk0lu-yEvPeoXI0xhXbJEOh2C7ECQgz9oT9FOPoGuM,352
+squirrels/_package_data/base_project/.env.example,sha256=U9DpOZfSI1MLkGAKd7jH6SiczWsBjGE7lJlyq_HObg4,1812
+squirrels/_package_data/base_project/connections.yml,sha256=eBIbTQqyp5FlxDs0HyQ_NuE2Nx87EW53Qp1Y_c1ygv0,1093
+squirrels/_package_data/base_project/duckdb_init.sql,sha256=PYUiQZajja-TG7EU1__PoiyDajgngEil4Lxenv5FWT0,284
+squirrels/_package_data/base_project/gitignore,sha256=B9OEkQ_j9fZGA2IAyVUvXeylxpya-AUwzLzqzMN4Bfc,155
+squirrels/_package_data/base_project/parameters.yml,sha256=--N_u3vA2tnT4uDxnkgxSs135i37N9N01gnYjD2jMRY,6741
+squirrels/_package_data/base_project/squirrels.yml.j2,sha256=6MDG1FnLYU507i6jkrlnBQDIlAnpO0tNUPLhqRlNSXM,1919
+squirrels/_package_data/base_project/dashboards/dashboard_example.py,sha256=XDRUxzb5Kyecylb2YV0Q3RD56Bw4doye_hhdgiQ6ck0,1800
+squirrels/_package_data/base_project/dashboards/dashboard_example.yml,sha256=2XU4zH8dBxnGxusMX8eOMOTPQAVLdQQ50w3B9GOiMR4,481
+squirrels/_package_data/base_project/docker/.dockerignore,sha256=IN0ZmxwLdmYlw6I2ziTdzXkTbZWCUyV4kfUI9_lDz-A,201
+squirrels/_package_data/base_project/docker/Dockerfile,sha256=0pi4IMXhZKcS6Nfg2wKATESZP84_r2Sp-Kh8cfMGOcY,470
+squirrels/_package_data/base_project/docker/compose.yml,sha256=c5_Zng1lF4eOYM2tPNk7n4WroLjz0Apu4PCXni77fws,105
+squirrels/_package_data/base_project/macros/macros_example.sql,sha256=kJMAxL9ihCd-ULPOfHkqt8TDIMcH6QAOFFw89VplGL0,508
+squirrels/_package_data/base_project/models/sources.yml,sha256=axBHFoJtWjAcklZyibrr7zhyDRATxi9r_bGjI09Kulk,1816
+squirrels/_package_data/base_project/models/builds/build_example.py,sha256=Obs1DpPTkXF4X7XxETJKxFnoPWPCrUWnaiV8N75IeWw,1024
+squirrels/_package_data/base_project/models/builds/build_example.sql,sha256=52tqAIzFWJgX13CP4HNeBd5BFy7Z929Z0XxfLgGKthM,508
+squirrels/_package_data/base_project/models/builds/build_example.yml,sha256=kUd6j5u8qU6UD294AowPBHFOb8yYDA_dxWlCIBrPl90,1407
+squirrels/_package_data/base_project/models/dbviews/dbview_example.sql,sha256=DXBdikZayi7XJrE3a4_PFgFZwT1hBzpnOp89858IGPE,369
+squirrels/_package_data/base_project/models/dbviews/dbview_example.yml,sha256=_wW3m0_pDMMbZHaJYjG5PKwOpcM5QlJbO0QiunOmEdA,1175
+squirrels/_package_data/base_project/models/federates/federate_example.py,sha256=13dcIibmsyvbNGOEAHYoYzE5jisZizH-Sghevd4pqmo,2057
+squirrels/_package_data/base_project/models/federates/federate_example.sql,sha256=9eTJfTSWAMV8lGtQ0Bg4A_Wpv0w1LRIf5fMx6OIZ7Uk,674
+squirrels/_package_data/base_project/models/federates/federate_example.yml,sha256=9zxJrpY3V-wRfGTyD4cBNc8hy5gPxGgOsAnIh-3YMCY,2163
+squirrels/_package_data/base_project/pyconfigs/connections.py,sha256=DGPQL39Aa3VyFQbFbmVmL_OvpjpQqmy2g_wfiPw5xfc,683
+squirrels/_package_data/base_project/pyconfigs/context.py,sha256=ln5p8r2DZX98qqxuEMSn0GG4ZIc6_ISAq7EnlzYSDZA,4325
+squirrels/_package_data/base_project/pyconfigs/parameters.py,sha256=-UlrCcuW2NqlNlEnYttQ-S09Lq5IpNkAVP5FNR2e33g,4794
+squirrels/_package_data/base_project/pyconfigs/user.py,sha256=ZVXxvMSO6mcuAKy_m2VOR55urlj5RVdrf18ga1qG49k,2554
+squirrels/_package_data/base_project/resources/expenses.db,sha256=aO0QdApW9ad8LRc73MW1o3eimryzmOAH5vz9Vc3dWK0,77824
+squirrels/_package_data/base_project/resources/weather.db,sha256=dsHPO36gQdZ4ULAA726Hg3jp8a1dCdig1DhrGg8wTeg,86016
+squirrels/_package_data/base_project/resources/public/.gitkeep,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+squirrels/_package_data/base_project/seeds/seed_categories.csv,sha256=jppjf1nOIxy7-bi5lJn5CVqmnLfJHHq0ABgp6UqbXnw,104
+squirrels/_package_data/base_project/seeds/seed_categories.yml,sha256=UM2gIrwHU2qogKdQqeqP6s4QfE7fEzUsPr7HjqlX7ow,425
+squirrels/_package_data/base_project/seeds/seed_subcategories.csv,sha256=Tta1oIgnc2nukNMDlUkIErRKNH_8YT5EPp1A2kQKcow,327
+squirrels/_package_data/base_project/seeds/seed_subcategories.yml,sha256=fqXzZfVIQIlrVjW83K3epnVYFvF0X2Kiqe3KpvHgI5c,573
+squirrels/_package_data/base_project/tmp/.gitignore,sha256=XImoqcWvJY0C0L_TWCx1ljvqU7qh9fUTJmK4ACCmNFI,13
+squirrels/_package_data/templates/login_successful.html,sha256=hWLQLG_cNxZhRD27p5k-C_ZZbQ-gl0I-mxgAX-BLoDk,1113
+squirrels/_package_data/templates/squirrels_studio.html,sha256=n0ymweLcaQYeMDaLBXV3Dt7TPO6HuPirX-WwpuQznxA,945
+squirrels/_schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+squirrels/_schemas/auth_models.py,sha256=iP-XSr20IurFMA-nb-vTEJeieEE58R97oFVKeXZgjNI,2985
+squirrels/_schemas/query_param_models.py,sha256=_afevpPU_aTCce-cu721_w7c5-T1N3-1XNF-CMoiwrA,4021
+squirrels/_schemas/request_models.py,sha256=_TYxdmy4zYpVzw2qIX2KjIba_-zvCVI7b1Nc3tE1BEw,919
+squirrels/_schemas/response_models.py,sha256=xIrwNIYuhyDOkRLH8j4bu2JNBzqhoFUZLtN1Glb5XRQ,20059
+squirrels-0.6.0.post0.dist-info/METADATA,sha256=LNQDfzm3A3px9BwBs3t84W4twm1W0V8NP4l7-InF-NA,5225
+squirrels-0.6.0.post0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+squirrels-0.6.0.post0.dist-info/entry_points.txt,sha256=i6vgjhJ3o_cdSFYofFcNY9DFMPr4MIcuwnkskSTXfJc,95
+squirrels-0.6.0.post0.dist-info/licenses/LICENSE,sha256=qqERuumQtQVsMrEXvJHuecJvV2sLxbleEubd_Zk8dY8,11338
+squirrels-0.6.0.post0.dist-info/RECORD,,

{squirrels-0.5.0b3.dist-info → squirrels-0.6.0.post0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: hatchling 1.28.0
 Root-Is-Purelib: true
 Tag: py3-none-any

squirrels/_api_response_models.py

@@ -1,190 +0,0 @@
-from typing import Annotated, Literal
-from pydantic import BaseModel, Field
-from datetime import datetime, date
-
-from . import _model_configs as mc, _sources as s
-
-
-class LoginReponse(BaseModel):
-    access_token: Annotated[str, Field(examples=["encoded_jwt_token"], description="An encoded JSON web token to use subsequent API requests")]
-    token_type: Annotated[str, Field(examples=["bearer"], description='Always "bearer" for Bearer token')]
-    username: Annotated[str, Field(examples=["johndoe"], description='The username authenticated with from the form data')]
-    is_admin: Annotated[bool, Field(examples=[False], description="A boolean for whether the user is an admin")]
-    expiry_time: Annotated[datetime, Field(examples=["2023-08-01T12:00:00.000000Z"], description="The expiry time of the access token in yyyy-MM-dd'T'hh:mm:ss.SSSSSS'Z' format")]
-
-
-## Parameters Response Models
-
-class ParameterOptionModel(BaseModel):
-    id: Annotated[str, Field(examples=["my_option_id"], description="The unique identifier for the option")]
-    label: Annotated[str, Field(examples=["My Option"], description="The human-friendly display name for the option")]
-
-class ParameterModelBase(BaseModel):
-    widget_type: Annotated[str, Field(examples=["disabled"], description="The parameter type")]
-    name: Annotated[str, Field(examples=["my_unique_param_name"], description="The name of the parameter. Use this as the key when providing the API request parameters")]
-    label: Annotated[str, Field(examples=["My Parameter"], description="The human-friendly display name for the parameter")]
-    description: Annotated[str, Field(examples=[""], description="The description of the parameter")]
-
-class NoneParameterModel(ParameterModelBase):
-    pass
-
-class SelectParameterModel(ParameterModelBase):
-    options: Annotated[list[ParameterOptionModel], Field(description="The list of dropdown options as JSON objects containing 'id' and 'label' fields")]
-    trigger_refresh: Annotated[bool, Field(description="A boolean that's set to true for parent parameters that require a new parameters API call when the selection changes")]
-
-class SingleSelectParameterModel(SelectParameterModel):
-    widget_type: Annotated[str, Field(examples=["single_select"], description="The parameter type (set to 'single_select' for this model)")]
-    selected_id: Annotated[str | None, Field(examples=["my_option_id"], description="The ID of the selected / default option")]
-
-class MultiSelectParameterModel(SelectParameterModel):
-    widget_type: Annotated[str, Field(examples=["multi_select"], description="The parameter type (set to 'multi_select' for this model)")]
-    show_select_all: Annotated[bool, Field(description="A boolean for whether there should be a toggle to select all options")]
-    order_matters: Annotated[bool, Field(description="A boolean for whether the ordering of the input selections would affect the result of the dataset")]
-    selected_ids: Annotated[list[str], Field(examples=[["my_option_id"]], description="A list of ids of the selected / default options")]
-
-class _DateTypeParameterModel(ParameterModelBase):
-    min_date: Annotated[date | None, Field(examples=["2023-01-01"], description='A string in "yyyy-MM-dd" format for the minimum date')]
-    max_date: Annotated[date | None, Field(examples=["2023-12-31"], description='A string in "yyyy-MM-dd" format for the maximum date')]
-
-class DateParameterModel(_DateTypeParameterModel):
-    widget_type: Annotated[str, Field(examples=["date"], description="The parameter type (set to 'date' for this model)")]
-    selected_date: Annotated[date, Field(examples=["2023-01-01"], description='A string in "yyyy-MM-dd" format for the selected / default date')]
-
-class DateRangeParameterModel(_DateTypeParameterModel):
-    widget_type: Annotated[str, Field(examples=["date_range"], description="The parameter type (set to 'date_range' for this model)")]
-    selected_start_date: Annotated[date, Field(examples=["2023-01-01"], description='A string in "yyyy-MM-dd" format for the selected / default start date')]
-    selected_end_date: Annotated[date, Field(examples=["2023-12-31"], description='A string in "yyyy-MM-dd" format for the selected / default end date')]
-
-class _NumericParameterModel(ParameterModelBase):
-    min_value: Annotated[float, Field(examples=[0], description="A number for the lower bound of the selectable number")]
-    max_value: Annotated[float, Field(examples=[10], description="A number for the upper bound of the selectable number")]
-    increment: Annotated[float, Field(examples=[1], description="A number for the selectable increments between the lower bound and upper bound")]
-
-class NumberParameterModel(_NumericParameterModel):
-    widget_type: Annotated[str, Field(examples=["number"], description="The parameter type (set to 'number' for this model)")]
-    selected_value: Annotated[float, Field(examples=[2], description="A number for the selected / default number")]
-
-class NumberRangeParameterModel(_NumericParameterModel):
-    widget_type: Annotated[str, Field(examples=["number_range"], description="The parameter type (set to 'number_range' for this model)")]
-    selected_lower_value: Annotated[float, Field(examples=[2], description="A number for the selected / default lower number")]
-    selected_upper_value: Annotated[float, Field(examples=[8], description="A number for the selected / default upper number")]
-
-class TextParameterModel(ParameterModelBase):
-    widget_type: Annotated[str, Field(examples=["text"], description="The parameter type (set to 'text' for this model)")]
-    entered_text: Annotated[str, Field(examples=["sushi"], description="A string for the default entered text")]
-    input_type: Annotated[str, Field(
-        examples=["text", "textarea", "number", "date", "datetime-local", "month", "time", "color", "password"],
-        description='A string for the input type (one of "text", "textarea", "number", "date", "datetime-local", "month", "time", "color", or "password")'
-    )]
-
-ParametersListType = list[
-    NoneParameterModel | SingleSelectParameterModel | MultiSelectParameterModel | DateParameterModel | DateRangeParameterModel | 
-    NumberParameterModel | NumberRangeParameterModel | TextParameterModel
-]
-
-class ParametersModel(BaseModel):
-    parameters: Annotated[ParametersListType, Field(description="The list of parameters for the dataset / dashboard")]
-
-
-## Datasets / Dashboards Catalog Response Models
-
-name_description = "The name of the dataset / dashboard (usually in snake case)"
-label_description = "The human-friendly display name for the dataset / dashboard"
-description_description = "The description of the dataset / dashboard"
-parameters_path_description = "The API path to the parameters for the dataset / dashboard"
-metadata_path_description = "The API path to the metadata (i.e., description and schema) for the dataset"
-result_path_description = "The API path to the results for the dataset / dashboard"
-
-class ColumnModel(BaseModel):
-    name: Annotated[str, Field(examples=["mycol"], description="Name of column")]
-    type: Annotated[str, Field(examples=["string", "integer", "boolean", "datetime"], description='Column type (such as "string", "integer", "boolean", "datetime", etc.)')]
-    description: Annotated[str, Field(examples=["My column description"], description="The description of the column")]
-    category: Annotated[str, Field(examples=["dimension", "measure", "misc"], description="The category of the column (such as 'dimension', 'measure', or 'misc')")]
-
-class ColumnWithConditionModel(ColumnModel):
-    condition: Annotated[str | None, Field(None, examples=["My condition"], description="The condition of when the column is included (such as based on a parameter selection)")]
-
-class SchemaModel(BaseModel):
-    fields: Annotated[list[ColumnModel], Field(description="A list of JSON objects containing the 'name' and 'type' for each of the columns in the result")]
-
-class SchemaWithConditionModel(BaseModel):
-    fields: Annotated[list[ColumnWithConditionModel], Field(description="A list of JSON objects containing the 'name' and 'type' for each of the columns in the result")]
-
-class DatasetItemModel(BaseModel):
-    name: Annotated[str, Field(examples=["mydataset"], description=name_description)]
-    label: Annotated[str, Field(examples=["My Dataset"], description=label_description)]
-    description: Annotated[str, Field(examples=[""], description=description_description)]
-    parameters: Annotated[list[str], Field(examples=["myparam1", "myparam2"], description="The list of parameter names used by the dataset")]
-    data_schema: Annotated[SchemaWithConditionModel, Field(alias="schema", description="JSON object describing the schema of the dataset")]
-    parameters_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/dataset/mydataset/parameters"], description=parameters_path_description)]
-    result_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/dataset/mydataset"], description=result_path_description)]
-
-class DashboardItemModel(ParametersModel):
-    name: Annotated[str, Field(examples=["mydashboard"], description=name_description)]
-    label: Annotated[str, Field(examples=["My Dashboard"], description=label_description)]
-    description: Annotated[str, Field(examples=[""], description=description_description)]
-    parameters: Annotated[list[str], Field(examples=["myparam1", "myparam2"], description="The list of parameter names used by the dashboard")]
-    parameters_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/dashboard/mydashboard/parameters"], description=parameters_path_description)]
-    result_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/dashboard/mydashboard"], description=result_path_description)]
-    result_format: Annotated[str, Field(examples=["png", "html"], description="The format of the dashboard's result API response (one of 'png' or 'html')")]
-
-ModelConfigType = mc.ModelConfig | s.Source | mc.SeedConfig | mc.BuildModelConfig | mc.DbviewModelConfig | mc.FederateModelConfig
-
-class ConnectionItemModel(BaseModel):
-    name: Annotated[str, Field(examples=["myconnection"], description="The name of the connection")]
-    label: Annotated[str, Field(examples=["My Connection"], description="The human-friendly display name for the connection")]
-
-class DataModelItem(BaseModel):
-    name: Annotated[str, Field(examples=["model_name"], description="The name of the model")]
-    model_type: Annotated[Literal["source", "dbview", "federate", "seed", "build"], Field(
-        examples=["source", "dbview", "federate", "seed", "build"], description="The type of the model"
-    )]
-    config: Annotated[ModelConfigType, Field(description="The configuration of the model")]
-    is_queryable: Annotated[bool, Field(examples=[True], description="Whether the model is queryable")]
-
-class LineageNode(BaseModel):
-    name: str
-    type: Literal["model", "dataset", "dashboard"]
-
-class LineageRelation(BaseModel):
-    type: Literal["buildtime", "runtime"]
-    source: LineageNode
-    target: LineageNode
-
-class CatalogModel(BaseModel):
-    parameters: Annotated[ParametersListType, Field(description="The list of all parameters in the project")]
-    datasets: Annotated[list[DatasetItemModel], Field(description="The list of accessible datasets")]
-    dashboards: Annotated[list[DashboardItemModel], Field(description="The list of accessible dashboards")]
-    connections: Annotated[list[ConnectionItemModel], Field(description="The list of connections in the project (only provided for admin users)")]
-    models: Annotated[list[DataModelItem], Field(description="The list of data models in the project (only provided for admin users)")]
-    lineage: Annotated[list[LineageRelation], Field(description="The lineage information between data assets (only provided for admin users)")]
-
-
-## Dataset Results Response Models
-
-class DataDetailsModel(BaseModel):
-    num_rows: Annotated[int, Field(examples=[2], description="The number of rows in the data field")]
-    orientation: Annotated[Literal["records", "rows", "columns"], Field(examples=["records", "rows", "columns"], description="The orientation of the data field")]
-
-class DatasetResultModel(BaseModel):
-    data_schema: Annotated[SchemaModel, Field(alias="schema", description="JSON object describing the schema of the dataset")]
-    total_num_rows: Annotated[int, Field(examples=[2], description="The total number of rows for the dataset")]
-    data_details: Annotated[DataDetailsModel, Field(description="A JSON object containing the details of the data field")]
-    data: Annotated[list[dict] | list[list] | dict[str, list], Field(
-        examples=[[{"mycol": "col_value1"}, {"mycol": "col_value2"}], [["col_value1"], ["col_value2"]], {"mycol": ["col_value1", "col_value2"]}],
-        description="A list of JSON objects where each object is a row of the tabular results. The keys and values of the object are column names (described in fields) and values of the row."
-    )]
-
-
-## Project Metadata Response Models
-
-class ProjectVersionModel(BaseModel):
-    major_version: Annotated[int, Field(examples=[1])]
-    data_catalog_path: Annotated[str, Field(examples=["/squirrels-v0/project/myproject/v1/data-catalog"])]
-
-class ProjectModel(BaseModel):
-    name: Annotated[str, Field(examples=["myproject"])]
-    version: Annotated[str, Field(examples=["v1"])]
-    label: Annotated[str, Field(examples=["My Project"])]
-    description: Annotated[str, Field(examples=["My project description"])]
-    squirrels_version: Annotated[str, Field(examples=["0.1.0"])]

squirrels/_dashboard_types.py

@@ -1,82 +0,0 @@
-import matplotlib.figure as figure, io, abc, typing
-
-from . import _constants as c
-
-
-class Dashboard(metaclass=abc.ABCMeta):
-    """
-    Abstract parent class for all Dashboard classes.
-    """
-    
-    @property
-    @abc.abstractmethod
-    def _content(self) -> bytes | str:
-        pass
-    
-    @property
-    @abc.abstractmethod
-    def _format(self) -> str:
-        pass
-
-
-class PngDashboard(Dashboard):
-    """
-    Instantiate a Dashboard in PNG format from a matplotlib figure or bytes
-    """
-    
-    def __init__(self, content: figure.Figure | io.BytesIO | bytes) -> None:
-        """
-        Constructor for PngDashboard
-
-        Arguments:
-            content: The content of the dashboard as a matplotlib.figure.Figure or bytes
-        """
-        if isinstance(content, figure.Figure):
-            buffer = io.BytesIO()
-            content.savefig(buffer, format=c.PNG)
-            content = buffer.getvalue()
-        
-        if isinstance(content, io.BytesIO):
-            content = content.getvalue()
-        
-        self.__content = content
-
-    @property
-    def _content(self) -> bytes:
-        return self.__content
-    
-    @property
-    def _format(self) -> typing.Literal['png']:
-        return c.PNG
-    
-    def _repr_png_(self):
-        return self._content
-    
-
-class HtmlDashboard(Dashboard):
-    """
-    Instantiate a Dashboard from an HTML string
-    """
-
-    def __init__(self, content: io.StringIO | str) -> None:
-        """
-        Constructor for HtmlDashboard
-
-        Arguments:
-            content: The content of the dashboard as HTML string
-        """
-        if isinstance(content, io.StringIO):
-            content = content.getvalue()
-        
-        self.__content = content
-
-    @property
-    def _content(self) -> str:
-        return self.__content
-    
-    @property
-    def _format(self) -> typing.Literal['html']:
-        return c.HTML
-    
-    def _repr_html_(self):
-        return self._content

squirrels/_dashboards_io.py

@@ -1,79 +0,0 @@
-from typing import Type, TypeVar, Callable, Coroutine, Any
-from enum import Enum
-from dataclasses import dataclass
-from pydantic import BaseModel, Field
-import os, time
-
-from ._arguments._run_time_args import DashboardArgs
-from ._py_module import PyModule
-from ._manifest import AnalyticsOutputConfig
-from ._exceptions import InvalidInputError, ConfigurationError, FileExecutionError
-from . import _constants as c, _dashboard_types as d, _utils as u
-
-T = TypeVar('T', bound=d.Dashboard)
-
-
-class DashboardFormat(Enum):
-    PNG = "png"
-    HTML = "html"
-
-class DashboardDependencies(BaseModel):
-    name: str
-    dataset: str
-    fixed_parameters: list[dict[str, str]] = Field(default_factory=list)
-
-class DashboardConfig(AnalyticsOutputConfig):
-    format: DashboardFormat = Field(default=DashboardFormat.PNG)
-    depends_on: list[DashboardDependencies] = Field(default_factory=list)
-
-
-@dataclass
-class DashboardDefinition:
-    dashboard_name: str
-    filepath: str
-    config: DashboardConfig
-
-    @property
-    def dashboard_func(self) -> Callable[[DashboardArgs], Coroutine[Any, Any, d.Dashboard]]:
-        if not hasattr(self, '_dashboard_func'):
-            module = PyModule(self.filepath)
-            self._dashboard_func = module.get_func_or_class(c.MAIN_FUNC)
-        return self._dashboard_func
-
-    def get_dashboard_format(self) -> str:
-        return self.config.format.value
-    
-    async def get_dashboard(self, args: DashboardArgs, *, dashboard_type: Type[T] = d.Dashboard) -> T:
-        try:
-            dashboard = await self.dashboard_func(args)
-            assert isinstance(dashboard, dashboard_type), f"Function does not return expected Dashboard type: {dashboard_type}"
-        except (InvalidInputError, ConfigurationError, FileExecutionError) as e:
-            raise e
-        except Exception as e:
-            raise FileExecutionError(f'Failed to run "{c.MAIN_FUNC}" function for dashboard "{self.dashboard_name}"', e) from e
-
-        return dashboard
-
-
-class DashboardsIO:
-
-    @classmethod
-    def load_files(cls, logger: u.Logger, base_path: str) -> dict[str, DashboardDefinition]:
-        start = time.time()
-        
-        dashboards_by_name = {}
-        for dp, _, filenames in os.walk(u.Path(base_path, c.DASHBOARDS_FOLDER)):
-            for file in filenames:
-                filepath = os.path.join(dp, file)
-                file_stem, extension = os.path.splitext(file)
-                if not extension == '.py':
-                    continue
-                
-                # Check for corresponding .yml file
-                yml_path = os.path.join(dp, file_stem + '.yml')
-                config_dict = u.load_yaml_config(yml_path) if os.path.exists(yml_path) else {}
-                config = DashboardConfig(name=file_stem, **config_dict)
-                dashboards_by_name[file_stem] = DashboardDefinition(file_stem, filepath, config)
-                
-        logger.log_activity_time("loading files for dashboards", start)
-        return dashboards_by_name