squirrels 0.4.1__py3-none-any.whl → 0.5.0__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.0.dist-info/METADATA

@@ -0,0 +1,113 @@
+Metadata-Version: 2.4
+Name: squirrels
+Version: 0.5.0
+Summary: Squirrels - API Framework for Data Analytics
+Project-URL: Homepage, https://squirrels-analytics.github.io
+Project-URL: Repository, https://github.com/squirrels-analytics/squirrels
+Project-URL: Documentation, https://squirrels-analytics.github.io
+Author-email: Tim Huang <tim.yuting@hotmail.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<2,>=1.5.2
+Requires-Dist: bcrypt<5,>=4.0.1
+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: mcp>=1.13.1
+Requires-Dist: pandas<3,>=2.1.4
+Requires-Dist: polars<2,>=1.14.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.12.1
+Requires-Dist: uvicorn<1,>=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://squirrels-analytics.github.io/" target="_blank">https://squirrels-analytics.github.io/</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)
+
+## 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 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 in a virtual environment, run:
+
+```bash
+uv sync
+```
+
+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
+```
+
+### Testing
+
+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.
+
+The library version is maintained in both the `pyproject.toml` and the `squirrels/_version.py` files.

squirrels-0.5.0.dist-info/RECORD

@@ -0,0 +1,97 @@
+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=kGqVF-QGG7VoaR9VxOO-0wuj8OvbbNV7ZsL34VAQ0O0,17454
+squirrels/_auth.py,sha256=2yEYrK9-w-mtRPUkv486nic0WTVfb_UIbWl7DiGtSyg,43572
+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=t0stGreMPXGRAB5cL2so2cmlMXpMSqRc0uepi2mooqE,4004
+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=KiGjr1rgU4p4UX4c8fZR6CQ86w7qvSyEEbNnu3Hkby0,52213
+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=7vhYrDFL_Bgpj3JLAA25VfNa9UEQdqGGFYbCJKWQgeo,37010
+squirrels/_py_module.py,sha256=NW86sv1oYWh8oMqgGh2oIUwuFcLXoq3cwEuKRxPfEwY,2683
+squirrels/_seeds.py,sha256=Q6ihhou5PBfdH2mKhWEkDOfpdi1CmftUtv8Yz3S18dg,2216
+squirrels/_sources.py,sha256=3tgI5FtMDzFtWBiHa2vF3x4Qaj5Pnu6hK_xSGBAcORI,5102
+squirrels/_utils.py,sha256=HKDv-Z4_lEUaKyOOhsDtdf-lAOA6aR4Iw0bHg_aKT4k,14710
+squirrels/_version.py,sha256=M8aFbJ4vlAi3Sk9b7leRuEfkNBjkkX5S_F9lA4h8GK4,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=TgzRB_yJ62xdIa90RRJfUbxtV_bWc6wsbNGn7A1rrMM,7772
+squirrels/_api_routes/dashboards.py,sha256=dY-FFO2zJA2g9QLw7I98hXzurJHrYe2FTdPGxKPRMD8,8904
+squirrels/_api_routes/data_management.py,sha256=oT_4etdDH55jI3fGbFkBgED9R2ji003S2HzSSc9JGpU,8607
+squirrels/_api_routes/datasets.py,sha256=v-qWCvLiJIKeuzDLXEoerK_By_02iQdvhDvNkKpMYW8,15256
+squirrels/_api_routes/oauth2.py,sha256=JXx5svIz0gVt6SHFOG-Ql9QcoJIizQ5IVFPPnZ5V1Bg,14827
+squirrels/_api_routes/project.py,sha256=LxCkKmlrt7fojpRDRVl7ac-FstWyIIRM-uQWGXIE06w,14146
+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=XJpbJ-kpgEnUBM45pN57Y9MOatPx5j-r2vM8_T4sw3U,7103
+squirrels/_package_data/base_project/squirrels.yml.j2,sha256=8wOaGd1jiEfbUJFAQcdbLQioonsU_UDUaRYyJ3dKm3U,1910
+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=jd6Sjs69QK4zBJlRnKaloati1cU5Oby1Pzg9bUxY0ZY,1637
+squirrels/_package_data/base_project/dashboards/dashboard_example.yml,sha256=fIm56M3J1eWp9_zDcc5R04pSLbHgdjm2X3XZgpB0SaQ,417
+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=RMET1ni2qeEFysxy3lSFHQOxYkfMHvs6G3JUzPhfklU,268
+squirrels/_package_data/base_project/models/dbviews/dbview_example.yml,sha256=lofWnI-fMN6L0q2Yxt6X-4nl6LHv4ZYggYYpRgFQZXI,930
+squirrels/_package_data/base_project/models/federates/federate_example.py,sha256=PvRmdgMaBjatiUclk8L4YvOAENoyb-CnkTJPerLvfLg,1459
+squirrels/_package_data/base_project/models/federates/federate_example.sql,sha256=-i6a4GzHDsiSsKmbsnftnMWh8l2BP447Eh2Qab3KEdo,616
+squirrels/_package_data/base_project/models/federates/federate_example.yml,sha256=FpSVZV7xNSH5iUAXMkyd_jynFxWryutz5Izlgsq3aP0,2279
+squirrels/_package_data/base_project/pyconfigs/connections.py,sha256=IRL9D2HG9pdwp12S896b0Q-hKnFfVck8we1q5sifX10,601
+squirrels/_package_data/base_project/pyconfigs/context.py,sha256=KN5hw23ydMqKLr7IEPHXsBTULZ9a63gECIGTpl1Qg9w,3543
+squirrels/_package_data/base_project/pyconfigs/parameters.py,sha256=-UlrCcuW2NqlNlEnYttQ-S09Lq5IpNkAVP5FNR2e33g,4794
+squirrels/_package_data/base_project/pyconfigs/user.py,sha256=KWfYO7IeGO3qaM9_hJnHMSovG55PvzqHQ6Jc8oKBPcE,1764
+squirrels/_package_data/base_project/seeds/seed_categories.csv,sha256=jppjf1nOIxy7-bi5lJn5CVqmnLfJHHq0ABgp6UqbXnw,104
+squirrels/_package_data/base_project/seeds/seed_categories.yml,sha256=NZ4BVvYYCEq6OnjRLrE_WOMhYsW0BQhRPWOgUchzdp4,435
+squirrels/_package_data/base_project/seeds/seed_subcategories.csv,sha256=Tta1oIgnc2nukNMDlUkIErRKNH_8YT5EPp1A2kQKcow,327
+squirrels/_package_data/base_project/seeds/seed_subcategories.yml,sha256=QTgw8Eld-p6Kntf53FyXyn7-7vKYI7IOJVu-Lr-FHCY,583
+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.0.dist-info/METADATA,sha256=FzhOxJIYUkCseGJJj1xFDAz6temOPRY0JUKMNXgA54E,4555
+squirrels-0.5.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+squirrels-0.5.0.dist-info/entry_points.txt,sha256=i6vgjhJ3o_cdSFYofFcNY9DFMPr4MIcuwnkskSTXfJc,95
+squirrels-0.5.0.dist-info/licenses/LICENSE,sha256=qqERuumQtQVsMrEXvJHuecJvV2sLxbleEubd_Zk8dY8,11338
+squirrels-0.5.0.dist-info/RECORD,,

{squirrels-0.4.1.dist-info → squirrels-0.5.0.dist-info}/WHEEL

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

squirrels-0.5.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+sqrl = squirrels._command_line:main
+squirrels = squirrels._command_line:main

{squirrels-0.4.1.dist-info → squirrels-0.5.0.dist-info/licenses}/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 Tim Huang
+   Copyright 2025 Tim Huang
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

squirrels/_authenticator.py

@@ -1,85 +0,0 @@
-from typing import Type, Optional
-from datetime import datetime, timedelta, timezone
-from jwt.exceptions import InvalidTokenError
-import secrets, jwt
-
-from . import _utils as u, _constants as c
-from .arguments.run_time_args import AuthArgs
-from ._py_module import PyModule
-from .user_base import User, WrongPassword
-from ._environcfg import EnvironConfig
-from ._manifest import DatasetScope
-from ._connection_set import ConnectionsArgs, ConnectionSet
-
-
-class Authenticator:
-
-    def __init__(self, base_path: str, env_cfg: EnvironConfig, conn_args: ConnectionsArgs, conn_set: ConnectionSet, token_expiry_minutes: int, *, auth_helper = None) -> None:
-        self.env_cfg = env_cfg
-        self.conn_args = conn_args
-        self.conn_set = conn_set
-        self.token_expiry_minutes = token_expiry_minutes
-        self.auth_helper = self._get_auth_helper(base_path, default_auth_helper=auth_helper)
-        self.user_cls: Type[User] = self.auth_helper.get_func_or_class("User", default_attr=User)
-        self.secret_key = self._get_secret_key()
-        self.algorithm = "HS256"
-    
-    def _get_auth_helper(self, base_path: str, *, default_auth_helper = None):
-        auth_module_path = u.Path(base_path, c.PYCONFIGS_FOLDER, c.AUTH_FILE)
-        return PyModule(auth_module_path, default_class=default_auth_helper)
-
-    def _get_secret_key(self) -> str:
-        secret_key = self.env_cfg.get_secret(c.JWT_SECRET_KEY, default_factory=lambda: secrets.token_hex(32))
-        return str(secret_key)
-    
-    def _get_auth_args(self, username: str, password: str):
-        connections = self.conn_set.get_engines_as_dict()
-        return AuthArgs(self.conn_args.proj_vars, self.conn_args.env_vars, self.conn_args._get_credential, connections, username, password)
-
-    def authenticate_user(self, username: str, password: str) -> Optional[User]:
-        get_user = self.auth_helper.get_func_or_class(c.GET_USER_FUNC, is_required=False)
-        try:
-            real_user = get_user(self._get_auth_args(username, password)) if get_user is not None else None
-        except Exception as e:
-            raise u.FileExecutionError(f'Failed to run "{c.GET_USER_FUNC}" in {c.AUTH_FILE}', e) from e
-        
-        if isinstance(real_user, User):
-            return real_user
-        
-        if not isinstance(real_user, WrongPassword):
-            fake_users = self.env_cfg.get_users()
-            if username in fake_users and secrets.compare_digest(fake_users[username].password, password):
-                fake_user = fake_users[username].model_dump()
-                fake_user.pop("username", "")
-                is_internal = fake_user.pop("is_internal", False)
-                try:
-                    return self.user_cls.Create(username, is_internal=is_internal, **fake_user)
-                except Exception as e:
-                    raise u.FileExecutionError(f'Failed to create user from User model in {c.AUTH_FILE}', e) from e
-        
-        return None
-    
-    def create_access_token(self, user: User) -> tuple[str, datetime]:
-        expire = datetime.now(timezone.utc) + timedelta(minutes=self.token_expiry_minutes)
-        to_encode = {**vars(user), "exp": expire}
-        encoded_jwt = jwt.encode(to_encode, self.secret_key, algorithm=self.algorithm)
-        return encoded_jwt, expire
-    
-    def get_user_from_token(self, token: Optional[str]) -> Optional[User]:
-        if token is not None:
-            try:
-                payload: dict = jwt.decode(token, self.secret_key, algorithms=[self.algorithm])
-                payload.pop("exp")
-                return self.user_cls._FromDict(payload)
-            except InvalidTokenError:
-                return None
-
-    def can_user_access_scope(self, user: Optional[User], scope: DatasetScope) -> bool:
-        if user is None:
-            user_level = DatasetScope.PUBLIC
-        elif not user.is_internal:
-            user_level = DatasetScope.PROTECTED
-        else:
-            user_level = DatasetScope.PRIVATE
-        
-        return user_level.value >= scope.value

squirrels/_dashboards_io.py

@@ -1,61 +0,0 @@
-from typing import Type, TypeVar, Callable, Coroutine, Any
-from dataclasses import dataclass
-import inspect, os, time
-
-from .arguments.run_time_args import DashboardArgs
-from ._py_module import PyModule
-from . import _constants as c, _utils as u, dashboards as d
-
-T = TypeVar('T', bound=d.Dashboard)
-
-
-@dataclass
-class DashboardFunction:
-    dashboard_name: str
-    filepath: str
-
-    @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_type = inspect.signature(self.dashboard_func).return_annotation
-        assert issubclass(return_type, d.Dashboard), f"Function must return Dashboard type"
-        if return_type == d.PngDashboard:
-            return c.PNG
-        elif return_type == d.HtmlDashboard:
-            return c.HTML
-        else:
-            raise NotImplementedError(f"Dashboard format {return_type} not supported")
-    
-    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 (u.InvalidInputError, u.ConfigurationError, u.FileExecutionError) as e:
-            raise e
-        except Exception as e:
-            raise u.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, DashboardFunction]:
-        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 extension == '.py':
-                    dashboards_by_name[file_stem] = DashboardFunction(file_stem, filepath)
-        
-        logger.log_activity_time("loading files for dashboards", start)
-        return dashboards_by_name

squirrels/_environcfg.py

@@ -1,84 +0,0 @@
-from pathlib import Path
-from typing import Any, Callable
-from pydantic import BaseModel, Field, field_validator, ValidationError
-import os, yaml, time
-
-from . import _constants as c, _utils as u
-
-_GLOBAL_SQUIRRELS_CFG_FILE = u.Path(os.path.expanduser('~'), '.squirrels', c.ENV_CONFIG_FILE)
-
-
-class _UserConfig(BaseModel, extra="allow"):
-    username: str
-    password: str
-    is_internal: bool = False
-
-
-class _CredentialsConfig(BaseModel):
-    username: str
-    password: str
-
-
-class EnvironConfig(BaseModel):
-    users: dict[str, _UserConfig] = Field(default_factory=dict)
-    env_vars: dict[str, str] = Field(default_factory=dict)
-    credentials: dict[str, _CredentialsConfig] = Field(default_factory=dict)
-    secrets: dict[str, Any | None] = Field(default_factory=dict)
-
-    @field_validator("users", mode="before")
-    @classmethod
-    def inject_username(cls, users: dict[str, dict[str, Any]]) -> dict[str, dict[str, Any]]:
-        processed_users = {}
-        for username, user in users.items():
-            processed_users[username] = {"username": username, **user}
-        return processed_users
-    
-    def get_users(self) -> dict[str, _UserConfig]:
-        return self.users.copy()
-    
-    def get_all_env_vars(self) -> dict[str, str]:
-        return self.env_vars.copy()
-    
-    def get_credential(self, key: str | None) -> tuple[str, str]:
-        if not key:
-            return "", ""
-
-        try:
-            credential = self.credentials[key]
-        except KeyError as e:
-            raise u.ConfigurationError(f'No credentials configured for "{key}"') from e
-    
-        return credential.username, credential.password
-    
-    def get_secret(self, key: str, default_factory: Callable[[], Any]) -> Any:
-        if self.secrets.get(key) is None:
-            self.secrets[key] = default_factory()
-        return self.secrets[key]
-
-
-class EnvironConfigIO:
-    
-    @classmethod
-    def load_from_file(cls, logger: u.Logger, base_path: str) -> EnvironConfig:
-        start = time.time()
-        def load_yaml(filename: str | Path) -> dict[str, dict]:
-            try:
-                with open(filename, 'r') as f:
-                    return yaml.safe_load(f)
-            except FileNotFoundError:
-                return {}
-        
-        master_env_config = load_yaml(_GLOBAL_SQUIRRELS_CFG_FILE)
-        proj_env_config = load_yaml(Path(base_path, c.ENV_CONFIG_FILE))
-
-        for key in proj_env_config:
-            master_env_config.setdefault(key, {})
-            master_env_config[key].update(proj_env_config[key])
-        
-        try:
-            env_cfg = EnvironConfig(**master_env_config)
-        except ValidationError as e:
-            raise u.ConfigurationError(f"Failed to process {c.ENV_CONFIG_FILE} file. " + str(e)) from e
-        
-        logger.log_activity_time(f"loading {c.ENV_CONFIG_FILE} file", start)
-        return env_cfg

squirrels/arguments/init_time_args.py

@@ -1,40 +0,0 @@
-from typing import Callable, Any
-from dataclasses import dataclass
-
-
-@dataclass
-class BaseArguments:
-    _proj_vars: dict[str, Any]
-    _env_vars: dict[str, Any]
-
-    @property
-    def proj_vars(self) -> dict[str, Any]:
-        return self._proj_vars.copy()
-    
-    @property
-    def env_vars(self) -> dict[str, Any]:
-        return self._env_vars.copy()
-
-
-@dataclass
-class ConnectionsArgs(BaseArguments):
-    _get_credential: Callable[[str | None], tuple[str, str]]
-
-    def get_credential(self, key: str | None) -> tuple[str, str]:
-        """
-        Return (username, password) tuple configured for credentials key in env.yaml
-
-        If key is None, returns tuple of empty strings ("", "")
-
-        Arguments:
-            key: The credentials key
-        
-        Returns:
-            A tuple of 2 strings
-        """
-        return self._get_credential(key)
-
-
-@dataclass
-class ParametersArgs(BaseArguments):
-    pass