Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pysquirrels.com/llms.txt

Use this file to discover all available pages before exploring further.

DashboardArgs is the class type of the sqrl argument for dashboard functions (i.e. the main function in dashboard files in the dashboards/ folder), which runs when an API request is made to the dashboard. The class can be imported from the squirrels.arguments or squirrels module.

​
Properties

​
project_path
str
Path to the Squirrels project directory.
​
proj_vars
dict[str, Any]
A copy of project variables as a dictionary.
​
env_vars
dict[str, str]
A copy of environment variables as a dictionary.

​
Methods

​
dataset()

Async method to get a dataset as a polars DataFrame given the dataset name. Unlike the dataset_result method of SquirrelsProject which requires parameter selections to be explicitly provided through code, this method automatically borrows selections applied to the dashboard. 
async def dataset(
    self, name: str, *, fixed_parameters: dict[str, Any] = {}
) -> polars.DataFrame:
​
returns
polars.DataFrame
A polars DataFrame of the dataset result.