squirrels 0.4.1__tar.gz → 0.5.0b2__tar.gz

squirrels-0.5.0b2/.gitignore

@@ -0,0 +1,81 @@
+sandbox*
+playground*
+site/
+.venv/ 
+
+# 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.0b2}/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.4.1 → squirrels-0.5.0b2}/PKG-INFO

@@ -1,39 +1,39 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: squirrels
-Version: 0.4.1
+Version: 0.5.0b2
 Summary: Squirrels - API Framework for Data Analytics
-Home-page: https://squirrels-analytics.github.io
-License: Apache-2.0
-Author: Tim Huang
-Author-email: tim.yuting@hotmail.com
-Requires-Python: >=3.10,<4.0
+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: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Typing :: Typed
-Provides-Extra: duckdb
-Requires-Dist: cachetools (>=5.3.2,<6.0.0)
-Requires-Dist: duckdb-engine (>=0.13.0,<1.0.0) ; extra == "duckdb"
-Requires-Dist: fastapi (>=0.112.1,<0.113.0)
-Requires-Dist: gitpython (>=3.1.41,<4.0.0)
-Requires-Dist: inquirer (>=3.2.1,<4.0.0)
-Requires-Dist: jinja2 (>=3.1.3,<4.0.0)
-Requires-Dist: matplotlib (>=3.8.3,<4.0.0)
-Requires-Dist: networkx (>=3.2.1,<4.0.0)
-Requires-Dist: pandas (>=2.1.4,<3.0.0)
-Requires-Dist: pydantic (>=2.8.2,<3.0.0)
-Requires-Dist: pyjwt (>=2.8.0,<3.0.0)
-Requires-Dist: python-multipart (>=0.0.9,<0.0.10)
-Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
-Requires-Dist: sqlalchemy (>=2.0.25,<3.0.0)
-Requires-Dist: uvicorn (>=0.30.6,<0.31.0)
-Project-URL: Documentation, https://squirrels-analytics.github.io
-Project-URL: Repository, https://github.com/squirrels-analytics/squirrels
+Requires-Python: ~=3.10
+Requires-Dist: bcrypt<5,>=4.0.1
+Requires-Dist: cachetools<6,>=5.3.2
+Requires-Dist: duckdb<2,>=1.1.3
+Requires-Dist: fastapi<1,>=0.112.1
+Requires-Dist: gitpython<4,>=3.1.41
+Requires-Dist: inquirer<4,>=3.2.1
+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: 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
@@ -60,10 +60,10 @@ 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 pandas dataframe) to define dynamic query logic based on parameter selections.
+- 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.
 - 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 (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!
 
 ## License
 
@@ -77,18 +77,18 @@ The sections below describe how to set up your local environment for squirrels d
 
 ### 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:
@@ -97,11 +97,9 @@ To confirm that the setup worked, run the following to show the help page for al
 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
 
@@ -110,8 +108,3 @@ From the root of the git repo, the source code can be found in the `squirrels` f
 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.4.1 → squirrels-0.5.0b2}/README.md

@@ -22,10 +22,10 @@ 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 pandas dataframe) to define dynamic query logic based on parameter selections.
+- 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.
 - 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 (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!
 
 ## License
 
@@ -39,18 +39,18 @@ The sections below describe how to set up your local environment for squirrels d
 
 ### 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:
@@ -59,11 +59,9 @@ To confirm that the setup worked, run the following to show the help page for al
 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
 
@@ -72,7 +70,3 @@ From the root of the git repo, the source code can be found in the `squirrels` f
 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.4.1/squirrels/dateutils.py → squirrels-0.5.0b2/dateutils/__init__.py

@@ -5,8 +5,6 @@ from dateutil.relativedelta import relativedelta
 from abc import ABCMeta, abstractmethod
 from enum import Enum
 
-from . import _utils as _u
-
 
 class DayOfWeek(Enum):
     Sunday = 0
@@ -62,7 +60,7 @@ class _DayIdxOfCalendarUnit(DateModifier):
         super().__init__()
         self.idx = idx
         if self.idx == 0:
-            raise _u.ConfigurationError(f"For constructors of class names that start with DayIdxOf_, idx cannot be zero")
+            raise ValueError(f"For constructors of class names that start with DayIdxOf_, idx cannot be zero")
         self.incr = self.idx - 1 if self.idx > 0 else self.idx
 
 
@@ -84,7 +82,7 @@ class DayIdxOfMonthsCycle(_DayIdxOfCalendarUnit):
         self._num_months_in_cycle = num_months_in_cycle
         self._first_month_of_cycle = first_month_of_cycle
         if 12 % self._num_months_in_cycle != 0:
-            raise _u.ConfigurationError(f"Value X must fit evenly in 12")
+            raise ValueError(f"Value X must fit evenly in 12")
         self.first_month_of_first_cycle = (self._first_month_of_cycle.value - 1) % self._num_months_in_cycle + 1
 
     def modify(self, date: Date) -> Date:
@@ -302,7 +300,7 @@ class DateModPipeline(DateModifier):
         """
         assert isinstance(step, _OffsetUnits)
         if step.offset == 0:
-            raise _u.ConfigurationError(f"The length of 'step' must not be zero")
+            raise ValueError(f"The length of 'step' must not be zero")
         
         output: Sequence[Date] = []
         end_date = self.modify(start_date)

squirrels-0.5.0b2/pyproject.toml

@@ -0,0 +1,75 @@
+[project]
+name = "squirrels"
+version = "0.5.0b2"
+description = "Squirrels - API Framework for Data Analytics"
+authors = [{ name = "Tim Huang", email = "tim.yuting@hotmail.com" }]
+requires-python = "~=3.10"
+readme = "README.md"
+license = "Apache-2.0"
+classifiers = [
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = [
+    "cachetools>=5.3.2,<6",
+    "fastapi>=0.112.1,<1",
+    "gitpython>=3.1.41,<4",
+    "inquirer>=3.2.1,<4",
+    "jinja2>=3.1.3,<4",
+    "matplotlib>=3.8.3,<4",
+    "networkx>=3.2.1,<4",
+    "pandas>=2.1.4,<3",
+    "pydantic>=2.8.2,<3",
+    "pyjwt>=2.8.0,<3",
+    "python-multipart>=0.0.9,<1",
+    "pyyaml>=6.0.1,<7",
+    "sqlalchemy>=2.0.25,<3",
+    "uvicorn>=0.30.6,<1",
+    "polars>=1.14.0,<2",
+    "pyarrow>=19.0.1",
+    "duckdb>=1.1.3,<2",
+    "sqlglot>=26.12.1",
+    "bcrypt>=4.0.1,<5",
+    "python-dotenv>=1.0.1,<2",
+    "libpass>=1.9.0,<2",
+]
+
+[project.urls]
+Homepage = "https://squirrels-analytics.github.io"
+Repository = "https://github.com/squirrels-analytics/squirrels"
+Documentation = "https://squirrels-analytics.github.io"
+
+[project.scripts]
+squirrels = "squirrels._command_line:main"
+sqrl = "squirrels._command_line:main"
+
+[dependency-groups]
+test = ["pytest>=7.4.4,<8"]
+dev = [
+    "ipykernel>=6.29.4,<7",
+    "plotly>=5.24.0,<6",
+    "psycopg2-binary>=2.9.10,<3",
+    "adbc-driver-postgresql>=1.3.0,<2",
+    "adbc-driver-sqlite>=1.3.0,<2",
+    "connectorx>=0.4.0,<0.5",
+    "faker>=33.1.0,<34",
+    "tqdm>=4.67.1,<5",
+]
+
+[tool.hatch.build.targets.sdist]
+include = ["squirrels", "dateutils"]
+
+[tool.hatch.build.targets.wheel]
+include = ["squirrels", "dateutils"]
+
+[tool.uv]
+default-groups = [
+    "test",
+    "dev",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

{squirrels-0.4.1 → squirrels-0.5.0b2}/squirrels/__init__.py

@@ -1,7 +1,7 @@
 from ._version import __version__
 
-from .arguments.init_time_args import ConnectionsArgs, ParametersArgs
-from .arguments.run_time_args import AuthArgs, ContextArgs, ModelDepsArgs, ModelArgs, DashboardArgs
+from .arguments.init_time_args import ConnectionsArgs, ParametersArgs, BuildModelArgs
+from .arguments.run_time_args import AuthLoginArgs, AuthTokenArgs, ContextArgs, ModelArgs, DashboardArgs
 
 from .parameter_options import SelectParameterOption, DateParameterOption, DateRangeParameterOption
 from .parameter_options import NumberParameterOption, NumberRangeParameterOption, TextParameterOption
@@ -9,11 +9,15 @@ from .parameter_options import NumberParameterOption, NumberRangeParameterOption
 from .parameters import SingleSelectParameter, MultiSelectParameter, DateParameter, DateRangeParameter
 from .parameters import NumberParameter, NumberRangeParameter, TextParameter, TextValue
 
-from .data_sources import SingleSelectDataSource, MultiSelectDataSource, SelectDataSource, DateDataSource, DateRangeDataSource
+from .data_sources import SelectDataSource, DateDataSource, DateRangeDataSource
 from .data_sources import NumberDataSource, NumberRangeDataSource, TextDataSource
 
-from .user_base import User, WrongPassword
-
 from .dashboards import PngDashboard, HtmlDashboard
 
-from .project import SquirrelsProject
+from ._auth import BaseUser
+
+from ._manifest import ConnectionProperties, ConnectionType
+
+from ._project import SquirrelsProject
+
+from .dataset_result import DatasetResult

{squirrels-0.4.1 → squirrels-0.5.0b2}/squirrels/_api_response_models.py

@@ -1,43 +1,18 @@
-from typing import Annotated
+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")]
 
 
-## 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"
-result_path_description = "The API path to the results for the dataset / dashboard"
-
-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_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(BaseModel):
-    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_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')")]
-
-class CatalogModel(BaseModel):
-    datasets: Annotated[list[DatasetItemModel], Field(description="The list of accessible datasets")]
-    dashboards: Annotated[list[DashboardItemModel], Field(description="The list of accessible dashboards")]
-
-
 ## Parameters Response Models
 
 class ParameterOptionModel(BaseModel):
@@ -45,7 +20,7 @@ class ParameterOptionModel(BaseModel):
     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=["none"], description="The parameter type (set to 'none' for this model)")]
+    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")]
@@ -102,27 +77,101 @@ class TextParameterModel(ParameterModelBase):
         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: list[
-        NoneParameterModel | SingleSelectParameterModel | MultiSelectParameterModel | DateParameterModel | DateRangeParameterModel | 
-        NumberParameterModel | NumberRangeParameterModel | TextParameterModel
-    ]
+    parameters: Annotated[ParametersListType, Field(description="The list of parameters for the dataset / dashboard")]
 
 
-## Dataset Results Response Models
+## 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", "number", "integer", "boolean", "datetime"], description='Column type. One of "string", "number", "integer", "boolean", and "datetime"')]
+    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")]
-    dimensions: Annotated[list[str], Field(examples=[["mycol"]], description="A list of column names that are dimensions")]
+
+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")]
-    data: Annotated[list[dict], Field(
-        examples=[[{"mycol": "myval"}]],
+    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."
     )]
 
@@ -130,12 +179,12 @@ class DatasetResultModel(BaseModel):
 ## Project Metadata Response Models
 
 class ProjectVersionModel(BaseModel):
-    major_version: int
-    minor_versions: list[int]
-    token_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/token"])]
-    data_catalog_path: Annotated[str, Field(examples=["/squirrels-v0/myproject/v1/datasets"])]
+    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"])]
-    versions: list[ProjectVersionModel]
+    description: Annotated[str, Field(examples=["My project description"])]
+    squirrels_version: Annotated[str, Field(examples=["0.1.0"])]