squirrels 0.5.0rc0__py3-none-any.whl → 0.5.1__py3-none-any.whl

squirrels/types.py

@@ -0,0 +1,16 @@
+from ._data_sources import DataSource
+
+from ._parameter_options import ParameterOption
+
+from ._parameters import Parameter, TextValue
+
+from ._dataset_types import DatasetMetadata, DatasetResult
+
+from ._dashboards import Dashboard
+
+from ._parameter_configs import ParameterConfigBase
+
+__all__ = [
+    "DataSource", "ParameterOption", "Parameter", "TextValue", 
+    "DatasetMetadata", "DatasetResult", "Dashboard", "ParameterConfigBase"
+]

{squirrels-0.5.0rc0.dist-info → squirrels-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: squirrels
-Version: 0.5.0rc0
+Version: 0.5.1
 Summary: Squirrels - API Framework for Data Analytics
 Project-URL: Homepage, https://squirrels-analytics.github.io
 Project-URL: Repository, https://github.com/squirrels-analytics/squirrels
@@ -13,26 +13,28 @@ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
 Requires-Python: ~=3.10
+Requires-Dist: authlib<2,>=1.5.2
 Requires-Dist: bcrypt<5,>=4.0.1
-Requires-Dist: cachetools<6,>=5.3.2
-Requires-Dist: duckdb<2,>=1.1.3
+Requires-Dist: cachetools>=5.3.2
+Requires-Dist: duckdb<2,>=1.4.0
 Requires-Dist: fastapi<1,>=0.112.1
 Requires-Dist: gitpython<4,>=3.1.41
 Requires-Dist: inquirer<4,>=3.2.1
+Requires-Dist: itsdangerous<3,>=2.2.0
 Requires-Dist: jinja2<4,>=3.1.3
+Requires-Dist: libpass<2,>=1.9.0
 Requires-Dist: matplotlib<4,>=3.8.3
-Requires-Dist: networkx<4,>=3.2.1
+Requires-Dist: mcp>=1.13.1
 Requires-Dist: pandas<3,>=2.1.4
-Requires-Dist: passlib<2,>=1.7.4
 Requires-Dist: polars<2,>=1.14.0
-Requires-Dist: pyarrow<19,>=18.0.0
+Requires-Dist: pyarrow>=19.0.1
 Requires-Dist: pydantic<3,>=2.8.2
 Requires-Dist: pyjwt<3,>=2.8.0
 Requires-Dist: python-dotenv<2,>=1.0.1
 Requires-Dist: python-multipart<1,>=0.0.9
 Requires-Dist: pyyaml<7,>=6.0.1
 Requires-Dist: sqlalchemy<3,>=2.0.25
-Requires-Dist: sqlglot<26,>=25.32.1
+Requires-Dist: sqlglot>=26.12.1
 Requires-Dist: uvicorn<1,>=0.30.6
 Description-Content-Type: text/markdown
 
@@ -48,22 +50,38 @@ Squirrels is an API framework that lets you create REST APIs for dynamic data an
 
 - [Main Features](#main-features)
 - [License](#license)
-- [Contributing to squirrels](#contributing-to-squirrels)
+- [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:
+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 Jinja SQL templates (just like dbt!) or python functions (that return a Python dataframe such as polars or pandas) to define dynamic query logic based on parameter selections.
+- 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 an interactive UI or by a command line that generates rendered sql queries and results (for a given set of parameter selections).
-- Define authentication logic (in `auth.py`) and authorize privacy scope per dataset (in `squirrels.yml`). The user's attributes can even be used in your query logic!
+- 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
 
@@ -71,46 +89,40 @@ Squirrels is released under the Apache 2.0 license.
 
 See the file LICENSE for more details.
 
-## Contributing to squirrels
+## 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.
+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 python version 3.10 or above to be installed. It also uses the python build tool `poetry`. Information on setting up poetry can be found at: https://python-poetry.org/docs/.
+This project requires python version 3.10 or above to be installed. It also uses the python package manager `uv`. Information on setting up poetry can be found at: https://docs.astral.sh/uv/getting-started/installation/.
 
-Then, to install all dependencies, run:
+Then, to install all dependencies in a virtual environment, run:
 
-```
-poetry install
+```bash
+uv sync
 ```
 
-And activate the virtual environment created by poetry with:
+And activate the virtual environment with:
 
-```
-poetry shell
+```bash
+source .venv/bin/activate
 ```
 
-To confirm that the setup worked, run the following to show the help page for all squirrels CLI commands:
+To confirm that the setup worked, run the following to show the help page for all Squirrels CLI commands:
 
 ```bash
 sqrl -h
 ```
 
-You can enter `exit` to exit the virtual environment shell. You can also run `poetry run sqrl -h` to run squirrels commands without activating the virtual environment.
-
 ### Testing
 
-In poetry's virtual environment, run `pytest`.
+Run `uv run pytest`. Or if you have the virtual environment activated, simply run `pytest`.
 
 ### 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.
 
-To understand what a specific squirrels command is doing, start from the `_command_line.py` file as your entry point.
+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.
-
-When a user initializes a squirrels project using `sqrl init`, the files are copied from the `squirrels/package_data/base_project` folder. The contents in the `database` subfolder were constructed from the scripts in the `database_elt` folder.
-
-For the Squirrels UI activated by `sqrl run`, the HTML, CSS, and Javascript files can be found in the `static` and `templates` subfolders of `squirrels/package_data`. The CSS and Javascript files are minified and built from the source files in this project: https://github.com/squirrels-analytics/squirrels-testing-ui.

squirrels-0.5.1.dist-info/RECORD

@@ -0,0 +1,98 @@
+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=f1Dh3hOqtU8ycMuXWY5s77kYw6O-PaWqQPPR4JMho_0,17965
+squirrels/_auth.py,sha256=wR49uT3mU-4PlgLcZqPgYjSbtwVYHm-2QyclApTiHLU,43532
+squirrels/_command_line.py,sha256=wTJr_WahULV8iZwUyhJIiNTGFd0YByprpo9DBDyczpU,12797
+squirrels/_compile_prompts.py,sha256=XIbRciSXak6NuDD4KedeDoUV5YSHvctQGk6HMxKchBw,5562
+squirrels/_connection_set.py,sha256=qSNcFdEKRcgZyr9OEqAuoIZBk-DY_C_aL_F7OE9GDK4,4457
+squirrels/_constants.py,sha256=SuAaceUN95BLdOt500A8fUx88dvwm-v-WBj3v87z4qM,4035
+squirrels/_dashboards.py,sha256=FF6KG-GXohR5Hp-BMYRwEZ2hUQ_jbkFpcK5epwoD64w,4891
+squirrels/_data_sources.py,sha256=jiTzYsECny4KBnalzuHYy6wQo4YXubJesDLH_a1M3dc,26433
+squirrels/_dataset_types.py,sha256=J9nhLVZ1eOk_qfqjEXRaXQTB9sqyZcE_iUad0NNstgU,2742
+squirrels/_exceptions.py,sha256=-hfDZoV-JhvuNRAERTFg-5NFjr0uNk4i9ogNgJfAyyc,1171
+squirrels/_initializer.py,sha256=9BDMGVbZLdRnV9erzqw1FvpKBlWRk8-uiSsl9UioxJ0,14249
+squirrels/_logging.py,sha256=dhFLZKde7iobSWSMwIBsbO_77tB0TYuDTpABRouAWkw,4142
+squirrels/_manifest.py,sha256=S4TicbPm5-4u9gEocbeO1dKb8CgTV8rsR5RERFjpkU0,12779
+squirrels/_model_builder.py,sha256=gOAcN_C0dfAvBe9YTM3QpdiA_2VeatRSHsALp2OVdJA,2844
+squirrels/_model_configs.py,sha256=eJne5L-QLv42s7uodUOOASMRn1NbzGbiBmwMllkO5C4,3303
+squirrels/_model_queries.py,sha256=2fl07feHtzddBpiXUWGfNBYeoN_EZ7K5mAz2Jc-vCvs,1087
+squirrels/_models.py,sha256=Nq0klbCDRcDF2KL0XlAZopqkSUpv0jaJQPlz3H255DM,54711
+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=hwzgC4sm6KMIASGlaLlhg-UheH5p0qIKU483pZRLRBU,10275
+squirrels/_parameters.py,sha256=Ta929_a-b8r1miDKXT_SZtHT_d8jJ2W5ABvkXL7k074,76372
+squirrels/_project.py,sha256=7ePxfCF6BTwsbE0i4XQRBm-OxvyAIYG7V36JG1Nyol8,37103
+squirrels/_py_module.py,sha256=NW86sv1oYWh8oMqgGh2oIUwuFcLXoq3cwEuKRxPfEwY,2683
+squirrels/_request_context.py,sha256=5FBxIQJ_Ki0sekZC_XrzS4GIegqoJuPnalQhGBsm-kQ,964
+squirrels/_seeds.py,sha256=Q6ihhou5PBfdH2mKhWEkDOfpdi1CmftUtv8Yz3S18dg,2216
+squirrels/_sources.py,sha256=3tgI5FtMDzFtWBiHa2vF3x4Qaj5Pnu6hK_xSGBAcORI,5102
+squirrels/_utils.py,sha256=5jhZ1UvK1ZR7IJno0TEVL3p6F9Sfx7osBU3Rqf9C2oI,14894
+squirrels/_version.py,sha256=4vCxnO9GT2Qn6oB5htQ_xPhxVh7TjOfYjzjZs11aM5s,105
+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=O4SMn9mqeV3wSEr_RIT1CKjumbqcbmZ6wk0tnXcxYHQ,437
+squirrels/_api_routes/__init__.py,sha256=-oGMDfM5Qo7NDiwpjHt8BKVZNNZ4798-NZCJzYCUdbc,106
+squirrels/_api_routes/auth.py,sha256=AvQbvyjrgEgN0kWPuBs8rgfJpsDL9ETFQbeFJ9S6qVw,15206
+squirrels/_api_routes/base.py,sha256=oAIe3JXCeUwEcnPVAhwv5TFtaGhaA-eCfteJI0oj1G0,8260
+squirrels/_api_routes/dashboards.py,sha256=BzSpidoQHyBoPk9igMbalVbnYiCSPbyfda9TW1QxyBw,9281
+squirrels/_api_routes/data_management.py,sha256=03GeaT4m4aKXFO-qvAH7XiFFNJVYimpBvR-p617Qxa0,8752
+squirrels/_api_routes/datasets.py,sha256=U8a1O8S7TeOO8QWPYEGXMdW1P9lqeRuFFGN7eYgApx8,15612
+squirrels/_api_routes/oauth2.py,sha256=JXx5svIz0gVt6SHFOG-Ql9QcoJIizQ5IVFPPnZ5V1Bg,14827
+squirrels/_api_routes/project.py,sha256=alH0IwyPe2-tctrTwok30BSogVAR2o7GX-lZRz261Ww,14140
+squirrels/_arguments/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+squirrels/_arguments/init_time_args.py,sha256=Y5gVbrU_yd1r5JtAChcL1xTpfz0i8gwNtZMe5QBT2mc,3511
+squirrels/_arguments/run_time_args.py,sha256=bnibUxUHnLvKR1tlri0WCuqRnYKXi0mJ8R_rhIDEil0,5100
+squirrels/_package_data/base_project/.env,sha256=KfUwxOG5KFicU1E-FkP8EyQRvAx5tAqXbZwtZxBPf08,1619
+squirrels/_package_data/base_project/.env.example,sha256=XPqYRUVCim1MnPU8iJe5y_sRpp9HObDrJk7NFd-SSao,1656
+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=MRJ130wNarGRQKXqBip9-OHVFVrsvqB1OghcU_ObcV0,1862
+squirrels/_package_data/base_project/assets/expenses.db,sha256=aO0QdApW9ad8LRc73MW1o3eimryzmOAH5vz9Vc3dWK0,77824
+squirrels/_package_data/base_project/assets/weather.db,sha256=dsHPO36gQdZ4ULAA726Hg3jp8a1dCdig1DhrGg8wTeg,86016
+squirrels/_package_data/base_project/dashboards/dashboard_example.py,sha256=c2B81GIlp7uGVplT5LFK9S2g06HRXjL6BfKu-XgeOfc,1621
+squirrels/_package_data/base_project/dashboards/dashboard_example.yml,sha256=qeJRKZwhEcpjs52DsBnjzTWV5TsChI2XAkzL8Oz43zA,485
+squirrels/_package_data/base_project/docker/.dockerignore,sha256=IN0ZmxwLdmYlw6I2ziTdzXkTbZWCUyV4kfUI9_lDz-A,201
+squirrels/_package_data/base_project/docker/Dockerfile,sha256=DBOfPajd7ikNr1Qg08TcQmQmWDYamlxoDv7u6FSWElE,470
+squirrels/_package_data/base_project/docker/compose.yml,sha256=xMAjfJeNVv49ypMGxR8bG27P5JSbPTNMR7UeGTHGyeA,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=QqNicirKK_JXn44QGrp48Ods5iGfAnoD_PZN5u-YLzQ,1022
+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=V2OWPN9TZ5yWB49SPcDMCzfz-zPhJ8RyQ08APF_P6xQ,1191
+squirrels/_package_data/base_project/models/federates/federate_example.py,sha256=xwquVszyMEEDaxUKsNQs9aA0x8FhSPnl7lvut9fQyeE,1969
+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=kxdgua47AWjvXPyLbpj4qS8Fmwj4A8RurKnzX-geHNU,2310
+squirrels/_package_data/base_project/pyconfigs/connections.py,sha256=XQ8PEVEF05jpWCMEowO_oWAW0QMeGKanwnJmKIZ7tDw,633
+squirrels/_package_data/base_project/pyconfigs/context.py,sha256=QinFkAryLqrbtSDzA360pgRA-U9koRgeRizJwo6Tv94,4305
+squirrels/_package_data/base_project/pyconfigs/parameters.py,sha256=-UlrCcuW2NqlNlEnYttQ-S09Lq5IpNkAVP5FNR2e33g,4794
+squirrels/_package_data/base_project/pyconfigs/user.py,sha256=wstsSgx1FYIMHtovESxvya1FJnDnSTIM0hYM7JcVSHk,1770
+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/dataset_results.html,sha256=Y-1xtw4ZzHcoW1vfWR1amnFJqFUMvwJDY3eeY7bfKJw,2793
+squirrels/_package_data/templates/oauth_login.html,sha256=LmR7zbjFUYxWIhB9nhIkoGDmqUgEtSXCqo0pKrWqwXw,7108
+squirrels/_package_data/templates/squirrels_studio.html,sha256=M0X3DP5dLRNvO6aJYSasbjWa4NbpsicrxAWV8Ephkyw,785
+squirrels/_schemas/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+squirrels/_schemas/auth_models.py,sha256=PEDr3jPmaQo7tigjhjyQZ6BYWafbzMUX-jZdo3jRtMU,6392
+squirrels/_schemas/query_param_models.py,sha256=y9ZYa2QLS_1tKN7ODSR0DBOWU-M6cz4niAq5qAAklok,4488
+squirrels/_schemas/response_models.py,sha256=3OVelx3DZmmze7RKmCFzukvHt1nIiLWfmzxSoCNpY50,15218
+squirrels-0.5.1.dist-info/METADATA,sha256=yLjuyu8i3LaaiaYYotMvNw4-CPxBbledjrdkDx4Czp8,4838
+squirrels-0.5.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+squirrels-0.5.1.dist-info/entry_points.txt,sha256=i6vgjhJ3o_cdSFYofFcNY9DFMPr4MIcuwnkskSTXfJc,95
+squirrels-0.5.1.dist-info/licenses/LICENSE,sha256=qqERuumQtQVsMrEXvJHuecJvV2sLxbleEubd_Zk8dY8,11338
+squirrels-0.5.1.dist-info/RECORD,,

squirrels/package_data/base_project/dashboards/dashboard_example.yml

@@ -1,22 +0,0 @@
-label: Dashboard Example
-
-description: This is an example dashboard
-
-scope: protected
-
-format: png
-
-parameters:
-  - date_range
-  - category
-
-depends_on:
-  - name: dataset_example_month
-    dataset: federate_dataset_example
-    fixed_parameters:
-      - group_by: g4 (Month)
-  
-  - name: dataset_example_subcategory
-    dataset: federate_dataset_example
-    fixed_parameters:
-      - group_by: g3 (Subcategory)

squirrels/package_data/base_project/macros/macros_example.sql

@@ -1,15 +0,0 @@
-{%- macro date_and_amount_filters(use_from_range) -%}
-    
-    {%- if use_from_range -%}
-        date >= {{ ctx.start_date_from_range }}
-        AND date <= {{ ctx.end_date_from_range }}
-        AND amount >= {{ ctx.min_amount_from_range }}
-        AND amount <= {{ ctx.max_amount_from_range }}
-    {%- else -%}
-        date >= {{ ctx.start_date }}
-        AND date <= {{ ctx.end_date }}
-        AND amount >= {{ ctx.min_amount }}
-        AND amount <= {{ ctx.max_amount }}
-    {%- endif -%}
-
-{%- endmacro -%}

squirrels/package_data/base_project/models/dbviews/dbview_example.sql

@@ -1,12 +0,0 @@
-{# SQLite dialect (based on connection used) #}
-
-SELECT STRFTIME('%Y-%m', date) AS month
-    , printf('%.2f', SUM(amount)) as total_amount
-
-FROM {{ source("src_transactions") }}
-
-WHERE {{ date_and_amount_filters(use_from_range=false) }}
-
-GROUP BY 1
-
-ORDER BY 1 DESC

squirrels/package_data/base_project/models/dbviews/dbview_example.yml

@@ -1,26 +0,0 @@
-description: |
-  This is an example of a database view model. It finds the total amount spent by month.
-
-  Parameters are available to filter the date and amount of the transactions.
-
-connection: default        # optional - if not provided, will use default connection specified in the SQRL_CONNECTIONS__DEFAULT_NAME_USED setting
-
-translate_to_duckdb: true  # optional - default is false - if true, then the model will be translated to duckdb for supported dialects
-
-depends_on:                # optional - the "source" macro also adds to this set
-  - src_transactions
-
-columns:
-  - name: month
-    type: string
-    description: The months for which the amount is aggregated by, in descending order
-    category: dimension
-    depends_on:
-      - src_transactions.date
-  
-  - name: total_amount
-    type: float
-    description: The total amount spent by the group-by dimension
-    category: measure
-    depends_on:
-      - src_transactions.amount

squirrels/package_data/base_project/models/federates/federate_example.py

@@ -1,44 +0,0 @@
-from squirrels import ModelArgs, parameters as p
-import polars as pl, pandas as pd
-
-def dequote(value: str) -> str:
-    return value[1:-1]
-
-def joined_str_to_list(value: str) -> list[str]:
-    return [dequote(category) for category in str(value).split(",")]
-
-
-def main(sqrl: ModelArgs) -> pl.LazyFrame | pl.DataFrame | pd.DataFrame:
-    """
-    Create federated models by joining/processing dependent models (sources, seeds, builds, dbviews, other federates, etc.) to
-    form a new Python DataFrame (using polars LazyFrame, polars DataFrame, or pandas DataFrame).
-    """
-    df = sqrl.ref("build_example")
-
-    df = df.filter(
-        (pl.col("amount") >= sqrl.ctx["min_amount_from_range"]) &
-        (pl.col("amount") <= sqrl.ctx["max_amount_from_range"]) &
-        (pl.col("date") >= dequote(sqrl.ctx["start_date_from_range"])) &
-        (pl.col("date") <= dequote(sqrl.ctx["end_date_from_range"]))
-    )
-
-    if sqrl.ctx["has_categories"]:
-        categories_list = joined_str_to_list(sqrl.ctx["categories"])
-        df = df.filter(pl.col("category_id").is_in(categories_list))
-
-    if sqrl.ctx["has_subcategories"]:
-        subcategories_list = joined_str_to_list(sqrl.ctx["subcategories"])
-        df = df.filter(pl.col("subcategory_id").is_in(subcategories_list))
-
-    dimension_cols = sqrl.ctx["group_by_cols_list"]
-    df = df.group_by(dimension_cols).agg(
-        pl.sum("amount").cast(pl.Decimal(precision=15, scale=2)).alias("total_amount")
-    )
-    df = df.sort(dimension_cols, descending=True)
-
-    if sqrl.param_exists("limit"):
-        assert isinstance(limit := sqrl.prms["limit"], p.NumberParameter)
-        df = df.limit(int(limit.get_selected_value()))
-
-    df = df.select(*dimension_cols, "total_amount")
-    return df.rename(sqrl.ctx["rename_dict"])

squirrels/package_data/base_project/models/federates/federate_example.sql

@@ -1,17 +0,0 @@
-{# DuckDB dialect #}
-
-SELECT {{ ctx.select_dim_cols }}
-    , CAST(SUM(amount) AS DECIMAL(15, 2)) as total_amount
-
-{# ref() can be used on a sources, seeds, builds, dbviews, or other federate models -#}
-FROM {{ ref("build_example") }} AS a
-
-WHERE {{ date_and_amount_filters(use_from_range=true) }}
-    {% if ctx.has_categories -%} AND category_id IN ({{ ctx.categories }}) {%- endif %}
-    {% if ctx.has_subcategories -%} AND subcategory_id IN ({{ ctx.subcategories }}) {%- endif %}
-
-GROUP BY {{ ctx.group_by_cols }}
-
-ORDER BY {{ ctx.order_by_cols }}
-
-{{ ctx.limit_clause }}

squirrels/package_data/base_project/pyconfigs/connections.py

@@ -1,14 +0,0 @@
-from typing import Any
-from squirrels import ConnectionsArgs, ConnectionProperties, ConnectionType
-
-
-def main(connections: dict[str, ConnectionProperties | Any], sqrl: ConnectionsArgs) -> None:
-    """
-    Define sqlalchemy engines by adding them to the "connections" dictionary
-    """
-    ## SQLAlchemy URL for a connection engine
-    conn_str: str = sqrl.env_vars["SQLITE_URI"].format(project_path=sqrl.project_path)
-
-    ## Assigning names to connection engines
-    connections["default"] = ConnectionProperties(label="SQLite Expenses Database", type=ConnectionType.SQLALCHEMY, uri=conn_str)
-    

squirrels/package_data/base_project/pyconfigs/parameters.py

@@ -1,93 +0,0 @@
-from squirrels import ParametersArgs, parameters as p, parameter_options as po, data_sources as ds
-
-
-def main(sqrl: ParametersArgs) -> None:
-    """
-    Create all widget parameters in this file. If two or more datasets use a different set of parameters, define them all
-    here, and specify the subset of parameters used for each dataset in the "squirrels.yml" file.
-
-    Parameters are created by a factory method associated to the parameter class. For example, "CreateWithOptions" is the factory method used here:
-    > p.SingleSelectParameter.CreateWithOptions(...)
-
-    The parameter classes available are:
-    - SingleSelectParameter, MultiSelectParameter, DateParameter, DateRangeParameter, NumberParameter, NumberRangeParameter, TextParameter
-    
-    The factory methods available are:
-    - CreateSimple, CreateWithOptions, CreateFromSource
-    """
-
-    ## Example of creating SingleSelectParameter and specifying each option by code
-    user_attribute = "role"
-    group_by_options = [
-        po.SelectParameterOption("g0", "Transaction", columns=["date", "category", "subcategory", "description"], user_groups=["manager"]),
-        po.SelectParameterOption("g1", "Day", columns=["date"], aliases=["day"], user_groups=["manager", "employee"]),
-        po.SelectParameterOption("g4", "Month", columns=["month"], user_groups=["manager", "employee"]),
-        po.SelectParameterOption("g2", "Category", columns=["category"], user_groups=["manager", "employee"]),
-        po.SelectParameterOption("g3", "Subcategory", columns=["category", "subcategory"], user_groups=["manager", "employee"]),
-    ]
-    p.SingleSelectParameter.CreateWithOptions(
-        "group_by", "Group By", group_by_options, description="Dimension(s) to aggregate by", user_attribute=user_attribute
-    )
-
-    ## Example of creating NumberParameter with options
-    parent = "group_by"
-    limit_options = [po.NumberParameterOption(0, 1000, increment=10, default_value=1000, parent_option_ids="g0")]
-    p.NumberParameter.CreateWithOptions(
-        "limit", "Max Number of Rows", limit_options, parent_name=parent, description="Maximum number of rows to return"
-    )
-
-    ## Example of creating DateParameter
-    start_date_source = ds.DateDataSource(
-        "SELECT min(date) AS min_date, max(date) AS max_date FROM expenses",
-        default_date_col="min_date", min_date_col="min_date", max_date_col="max_date"
-    )
-    p.DateParameter.CreateFromSource(
-        "start_date", "Start Date", start_date_source, description="Start date to filter transactions by"
-    )
-
-    ## Example of creating DateParameter from list of DateParameterOption's
-    end_date_option = [po.DateParameterOption("2024-12-31", min_date="2024-01-01", max_date="2024-12-31")]
-    p.DateParameter.CreateWithOptions(
-        "end_date", "End Date", end_date_option, description="End date to filter transactions by"
-    )
-
-    ## Example of creating DateRangeParameter
-    p.DateRangeParameter.CreateSimple(
-        "date_range", "Date Range", "2024-01-01", "2024-12-31", min_date="2024-01-01", max_date="2024-12-31",
-        description="Date range to filter transactions by"
-    )
-
-    ## Example of creating MultiSelectParameter from lookup query/table
-    category_ds = ds.SelectDataSource("seed_categories", "category_id", "category", from_seeds=True)
-    p.MultiSelectParameter.CreateFromSource(
-        "category", "Category Filter", category_ds, description="The expense categories to filter transactions by"
-    )
-
-    ## Example of creating MultiSelectParameter with parent from lookup query/table
-    parent_name = "category"
-    subcategory_ds = ds.SelectDataSource(
-        "seed_subcategories", "subcategory_id", "subcategory", from_seeds=True, parent_id_col="category_id"
-    )
-    p.MultiSelectParameter.CreateFromSource(
-        "subcategory", "Subcategory Filter", subcategory_ds, parent_name=parent_name,
-        description="The expense subcategories to filter transactions by (available options are based on selected value(s) of 'Category Filter')"
-    )
-
-    ## Example of creating NumberParameter
-    p.NumberParameter.CreateSimple(
-        "min_filter", "Amounts Greater Than", min_value=0, max_value=300, increment=10,
-        description="Number to filter on transactions with an amount greater than this value"
-    )
-    
-    ## Example of creating NumberParameter from lookup query/table
-    query = "SELECT 0 as min_value, 300 as max_value, 10 as increment"
-    max_amount_ds = ds.NumberDataSource(query, "min_value", "max_value", increment_col="increment", default_value_col="max_value")
-    p.NumberParameter.CreateFromSource(
-        "max_filter", "Amounts Less Than", max_amount_ds, description="Number to filter on transactions with an amount less than this value"
-    )
-
-    ## Example of creating NumberRangeParameter
-    p.NumberRangeParameter.CreateSimple(
-        "between_filter", "Amounts Between", 0, 300, default_lower_value=0, default_upper_value=300,
-        description="Number range to filter on transactions with an amount within this range"
-    )

squirrels/package_data/base_project/pyconfigs/user.py

@@ -1,23 +0,0 @@
-from typing import Literal
-from squirrels import BaseUser
-
-
-class User(BaseUser):
-    """
-    Extend the BaseUser class with custom attributes. The attributes defined here will be added as columns to the users table. 
-    - Only the following types are supported: [str, int, float, bool, typing.Literal]
-    - For str, int, and float types, add "| None" after the type to make it nullable. 
-    - Always set a default value for the column (use None if default is null).
-    
-    Example:
-        organization: str | None = None
-    """
-    role: Literal["manager", "employee"] = "employee"
-
-    @classmethod
-    def dropped_columns(cls) -> list[str]:
-        """
-        The fields defined above cannot be modified once added to the database. 
-        However, you can choose to drop columns by adding them to this list.
-        """
-        return []

squirrels/package_data/base_project/squirrels.yml.j2

@@ -1,71 +0,0 @@
-project_variables:
-  name: sample
-  label: Sample Project - Expenses
-  description: This is a sample squirrels project for analyzing expense transactions
-  major_version: 1
-
-
-packages: []
-
-## Example for packages section:
-# packages:
-#   - git: https://.../myrepo.git
-#     revision: v0.1.0
-#     directory: custom_name ## optional
-
-
-{{ connections -}}
-
-
-{{ parameters -}}
-
-
-datasets:
-  - name: dbview_dataset_example          ## model name uses same name unless "model" field is specified
-    label: Example Dataset from DBView Model
-    description: Aggregated expense transactions by month using dbview_example model
-    model: dbview_example 
-    scope: public                         ## optional - one of 'public' (default), 'protected', or 'private'
-    parameters:                           ## optional - if not specified, then all parameters are used
-      - start_date
-      - end_date
-      - min_filter
-      - max_filter
-    traits: {}                            ## optional - defaults to empty object
-  
-  - name: federate_dataset_example
-    label: Example Dataset from Federate Model
-    description: Aggregated expense transactions by custom dimension using federate_example model
-    model: federate_example 
-    scope: protected                      ## using an auth.py file is suggested for protected or private datasets
-    parameters:
-      - group_by
-      - limit
-      - date_range
-      - category
-      - subcategory
-      - between_filter
-    default_test_set: auth_test1          ## optional - if not specified, uses setting 'selection_test_sets.default_name_used'
-
-
-selection_test_sets:
-  - name: no_auth_test1
-    datasets:                             ## optional section - if not provided, then test set is applicable for any dataset
-      - dbview_dataset_example
-    parameters:                           ## optional section - if not provided, then assumes no parameters. For unspecified parameters, default value is used
-      start_date: 2024-07-01              ## this parameter only exists for dataset 'dataset_example'
-  
-  - name: auth_test1
-    datasets:
-      - federate_dataset_example
-    user_attributes:                      ## optional section - required if using test set on non-public datasets
-      role: employee
-    parameters:
-      date_range: [2024-02-01,2024-12-01] ## this parameter only exists for dataset 'protected_dataset_example'
-    
-  - name: auth_test2
-    user_attributes:
-      is_internal: True                   ## optional - defaults to False
-      role: manager
-    parameters:
-      group_by: g3                        ## this parameter exists for all datasets. "g3" is the id for option "subcategory"