squirrels 0.4.1__tar.gz → 0.5.0__tar.gz

squirrels-0.5.0/.gitignore

@@ -0,0 +1,82 @@
+sandbox*
+playground*
+site/
+.venv/
+TODOS.md
+
+# pyenv files
+.python-version
+
+# Pipenv files
+Pipfile
+Pipfile.lock
+
+### PythonVanilla ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+
+### VisualStudioCode ###
+.vscode
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide

{squirrels-0.4.1 → squirrels-0.5.0}/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-0.5.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,73 @@
+# 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/dateutils/__init__.py

@@ -0,0 +1,6 @@
+from ._enums import DayOfWeekEnum, MonthEnum
+from ._implementation import (
+    DayIdxOfMonthsCycle, DayIdxOfYear, DayIdxOfQuarter, DayIdxOfMonth, DayIdxOfWeek,
+    OffsetYears, OffsetMonths, OffsetWeeks, OffsetDays,
+    DateModPipeline, DateStringModifier, TimestampModifier
+)

squirrels-0.5.0/dateutils/_enums.py

@@ -0,0 +1,25 @@
+from enum import Enum
+
+
+class DayOfWeekEnum(Enum):
+    Sunday = 0
+    Monday = 1
+    Tuesday = 2
+    Wednesday = 3
+    Thursday = 4
+    Friday = 5
+    Saturday = 6
+
+class MonthEnum(Enum):
+    January = 1
+    February = 2
+    March = 3
+    April = 4
+    May = 5
+    June = 6
+    July = 7
+    August = 8
+    September = 9
+    October = 10
+    November = 11
+    December = 12