Skip to main content
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. 
async def dataset(
    self, name: str, *, fixed_parameters: dict[str, Any] = {}
) -> polars.DataFrame:
​
returns
polars.DataFrame
A polars DataFrame of the dataset result.