squirrels 0.5.0b3__py3-none-any.whl → 0.6.0.post0__py3-none-any.whl

squirrels/_package_data/base_project/.env

@@ -1,30 +1,7 @@
 # Custom environment variables
-SQLITE_URI="sqlite:///{project_path}/assets/expenses.db"
+SQLITE_URI="sqlite:///{project_path}/resources/expenses.db"
 
 # Secrets used by the Squirrels framework that are NOT SAFE TO INCLUDE IN VERSION CONTROL
 # Required if your project uses authentication. Otherwise, optional.
 SQRL_SECRET__KEY="{{ random_secret_key }}"
 SQRL_SECRET__ADMIN_PASSWORD="{{ random_admin_password }}"
-
-# Optional variables used by the Squirrels framework that are safe to include in version control if desired
-# (default values are shown below)
-SQRL_AUTH__DB_FILE_PATH="target/auth.sqlite"
-SQRL_AUTH__TOKEN_EXPIRE_MINUTES="30"
-
-SQRL_PARAMETERS__CACHE_SIZE="1024"
-SQRL_PARAMETERS__CACHE_TTL_MINUTES="60"
-
-SQRL_DATASETS__CACHE_SIZE="128"
-SQRL_DATASETS__CACHE_TTL_MINUTES="60"
-
-SQRL_DASHBOARDS__CACHE_SIZE="128"
-SQRL_DASHBOARDS__CACHE_TTL_MINUTES="60"
-
-SQRL_SEEDS__INFER_SCHEMA="true"
-SQRL_SEEDS__NA_VALUES=["NA"] # must be a JSON list
-
-SQRL_TEST_SETS__DEFAULT_NAME_USED="default"
-
-SQRL_CONNECTIONS__DEFAULT_NAME_USED="default"
-
-SQRL_DUCKDB_VENV__DB_FILE_PATH="target/venv.duckdb"

squirrels/_package_data/base_project/.env.example

@@ -1,30 +1,44 @@
 # Custom environment variables
-SQLITE_URI="sqlite:///{project_path}/assets/expenses.db"
+SQLITE_URI="sqlite:///{project_path}/resources/expenses.db"
 
 # Secrets used by the Squirrels framework that are NOT SAFE TO INCLUDE IN VERSION CONTROL
 # Required if your project uses authentication. Otherwise, optional.
-SQRL_SECRET__KEY="" # a random 32 byte hex string - one way to generate this is by running "openssl rand -hex 32" in bash
+SQRL_SECRET__KEY="" # a random 32 byte hex string - you can generate this is by running `python -c "import secrets; print(secrets.token_hex(32))"`
 SQRL_SECRET__ADMIN_PASSWORD=""
 
-# Optional variables used by the Squirrels framework that are safe to include in version control if desired
-# (default values are shown below)
-SQRL_AUTH__DB_FILE_PATH="target/auth.sqlite"
-SQRL_AUTH__TOKEN_EXPIRE_MINUTES="30"
+# # Optional variables used by the Squirrels framework that are safe to include in version control if desired
+# # (default values are shown below)
+# SQRL_AUTH__DB_FILE_PATH="{project_path}/target/auth.sqlite"
+# SQRL_AUTH__TOKEN_EXPIRE_MINUTES="30"
+# SQRL_AUTH__ALLOWED_ORIGINS_FOR_COOKIES="https://squirrels-analytics.github.io"
 
-SQRL_PARAMETERS__CACHE_SIZE="1024"
-SQRL_PARAMETERS__CACHE_TTL_MINUTES="60"
+# SQRL_PARAMETERS__CACHE_SIZE="1024"
+# SQRL_PARAMETERS__CACHE_TTL_MINUTES="60"
+# SQRL_PARAMETERS__DATASOURCE_REFRESH_MINUTES="60"
 
-SQRL_DATASETS__CACHE_SIZE="128"
-SQRL_DATASETS__CACHE_TTL_MINUTES="60"
+# SQRL_DATASETS__CACHE_SIZE="128"
+# SQRL_DATASETS__CACHE_TTL_MINUTES="60"
+# SQRL_DATASETS__MAX_ROWS_FOR_AI="100"
+# SQRL_DATASETS__MAX_ROWS_OUTPUT="100000"
+# SQRL_DATASETS__SQL_TIMEOUT_SECONDS="2"
 
-SQRL_DASHBOARDS__CACHE_SIZE="128"
-SQRL_DASHBOARDS__CACHE_TTL_MINUTES="60"
+# SQRL_DASHBOARDS__CACHE_SIZE="128"
+# SQRL_DASHBOARDS__CACHE_TTL_MINUTES="60"
 
-SQRL_SEEDS__INFER_SCHEMA="true"
-SQRL_SEEDS__NA_VALUES=["NA"] # must be a JSON list
+# SQRL_PERMISSIONS__ELEVATED_ACCESS_LEVEL="admin" # one of "admin", "member", "guest"
 
-SQRL_TEST_SETS__DEFAULT_NAME_USED="default"
+# SQRL_SEEDS__INFER_SCHEMA="true"
+# SQRL_SEEDS__NA_VALUES=["NA"] # must be a JSON list
 
-SQRL_CONNECTIONS__DEFAULT_NAME_USED="default"
+# SQRL_CONNECTIONS__DEFAULT_NAME_USED="default"
 
-SQRL_DUCKDB_VENV__DB_FILE_PATH="target/venv.duckdb"
+# SQRL_VDL__CATALOG_DB_PATH="ducklake:{project_path}/target/vdl_catalog.duckdb"
+# SQRL_VDL__DATA_PATH="{project_path}/target/vdl_data/"
+
+# SQRL_STUDIO__BASE_URL="https://squirrels-analytics.github.io/squirrels-studio-v2"
+
+# SQRL_LOGGING__LEVEL="INFO" # one of "DEBUG", "INFO", "WARNING"
+# SQRL_LOGGING__FORMAT="text"
+# SQRL_LOGGING__TO_FILE="false"
+# SQRL_LOGGING__FILE_SIZE_MB="50"
+# SQRL_LOGGING__FILE_BACKUP_COUNT="1"

squirrels/_package_data/base_project/connections.yml

@@ -1,7 +1,8 @@
 ## Connection URIs are usually in format "dialect://username:password@host:port/database" for database connections
 ## However, subtle differences exist depending on the "type" specified. For example, sqlite URIs are slightly different.
-##   sqlalchemy:      sqlite:///relative/path/to/database.db
-##   connectorx/adbc: sqlite://relative/path/to/database.db  (adbc URI format matches connectorx thanks to polars integration)
+##   sqlalchemy:      sqlite:///{project_path}/relative/path/to/database.db
+##   connectorx/adbc: sqlite://{project_path}/relative/path/to/database.db  (adbc URI format matches connectorx)
+##   duckdb:          sqlite:{project_path}/relative/path/to/database.db
 ## Refer to specific documentation for supported databases by type (with URI examples):
 ##   sqlalchemy: https://docs.sqlalchemy.org/en/latest/core/engines.html#database-urls
 ##   connectorx: https://sfu-db.github.io/connector-x/databases.html
@@ -9,7 +10,7 @@
 connections:
   - name: default
     label: SQLite Expenses Database
-    type: sqlalchemy                      ## one of: sqlalchemy, connectorx, or adbc
+    type: sqlalchemy                      ## one of: sqlalchemy, connectorx, adbc, or duckdb
     uri: {{ env_vars.SQLITE_URI }}        ## using Jinja to substitute environment variables
 
 

squirrels/_package_data/base_project/dashboards/dashboard_example.py

@@ -1,14 +1,20 @@
-from squirrels import arguments as args, dashboards as d
-from matplotlib import pyplot as plt, figure as f, axes as a
+from squirrels.arguments import DashboardArgs
+from squirrels.dashboards import PngDashboard, HtmlDashboard
+from matplotlib import pyplot as plt, figure as fg, axes as a
+import asyncio
 
 
-async def main(sqrl: args.DashboardArgs) -> d.PngDashboard:
-    spending_by_month_df = await sqrl.dataset("federate_dataset_example", fixed_parameters={"group_by": "month"})
-    spending_by_subcategory_df = await sqrl.dataset("federate_dataset_example", fixed_parameters={"group_by": "subcat"})
+async def main(sqrl: DashboardArgs) -> PngDashboard | HtmlDashboard:
+    # Get dataset instances concurrently
+    all_dataframes = await asyncio.gather(
+        sqrl.dataset("grouped_expenses", fixed_parameters={"group_by": "month"}),
+        sqrl.dataset("grouped_expenses", fixed_parameters={"group_by": "subcat"})
+    )
+    spending_by_month_df, spending_by_subcategory_df = all_dataframes
 
     # Create a figure with two subplots
     fig, (ax0, ax1) = plt.subplots(2, 1, figsize=(8, 8), height_ratios=(1, 2))
-    fig: f.Figure; ax0: a.Axes; ax1: a.Axes
+    fig: fg.Figure; ax0: a.Axes; ax1: a.Axes
     fig.tight_layout(pad=4, h_pad=6)
 
     # Create a bar chart of spending by month
@@ -31,4 +37,4 @@ async def main(sqrl: args.DashboardArgs) -> d.PngDashboard:
     subcategory_pandas.plot(y="total_amount", kind='pie', ax=ax1, autopct=autopct, legend=False, ylabel="")
     ax1.set_title("Spending by Subcategory")
     
-    return d.PngDashboard(fig)
+    return PngDashboard(fig)

squirrels/_package_data/base_project/dashboards/dashboard_example.yml

@@ -1,6 +1,6 @@
-label: Dashboard Example
+label: Expense Dashboard
 
-description: This is an example dashboard
+description: This is a dashboard showing the total expense amounts by month as a line chart and by subcategory as a pie chart
 
 scope: protected
 
@@ -12,11 +12,11 @@ parameters:
 
 depends_on:
   - name: dataset_example_month
-    dataset: federate_dataset_example
+    dataset: grouped_expenses
     fixed_parameters:
-      - group_by: month (Month)
+      group_by: month (Month)
   
   - name: dataset_example_subcategory
-    dataset: federate_dataset_example
+    dataset: grouped_expenses
     fixed_parameters:
-      - group_by: subcat (Subcategory)
+      group_by: subcat (Subcategory)

squirrels/_package_data/base_project/docker/Dockerfile

@@ -12,5 +12,5 @@ RUN pip install --no-cache-dir -r requirements.txt
 
 RUN sqrl deps
 
-EXPOSE 4465
-CMD ["sqrl", "run", "--build", "--host", "0.0.0.0", "--port", "4465"]
+EXPOSE 8000
+CMD ["sqrl", "run", "--build", "--host", "0.0.0.0", "--port", "8000"]

squirrels/_package_data/base_project/docker/compose.yml

@@ -2,6 +2,6 @@ services:
   squirrels:
     build: .
     ports:
-      - "4465:4465"
+      - "8000:8000"
     volumes:
       - ./.env:/app/.env

squirrels/_package_data/base_project/duckdb_init.sql

@@ -1,4 +1,5 @@
 -- SQL statements that run at the start of every DuckDB session
+-- If the VDL catalog path is provided, the project will ATTACH it as 'vdl' (READ_ONLY)
 
 -- Example:
 

squirrels/_package_data/base_project/models/builds/build_example.py

@@ -1,8 +1,8 @@
-from squirrels import arguments as args
+from squirrels.arguments import BuildModelArgs
 import polars as pl, pandas as pd
 
 
-def main(sqrl: args.BuildModelArgs) -> pl.LazyFrame | pl.DataFrame | pd.DataFrame:
+def main(sqrl: BuildModelArgs) -> pl.LazyFrame | pl.DataFrame | pd.DataFrame:
     """
     Create a build model by joining/processing sources or other build models to form a new
     Python DataFrame (using polars LazyFrame, polars DataFrame, or pandas DataFrame).

squirrels/_package_data/base_project/models/dbviews/dbview_example.sql

@@ -1,7 +1,12 @@
 {#- SQLite dialect (based on connection used) -#}
 
-SELECT STRFTIME('%Y-%m', date) AS month
-    , printf('%.2f', SUM(amount)) as total_amount
+SELECT 
+    date,
+    printf('%.2f', amount) as amount,
+    CASE 
+        WHEN '{{ user.custom_fields.role }}' = 'manager' THEN description
+        ELSE '***MASKED***'
+    END as description
 
 FROM {{ source("src_transactions") }}
 

squirrels/_package_data/base_project/models/dbviews/dbview_example.yml

@@ -1,26 +1,32 @@
 description: |
-  This is an example of a database view model. It finds the total amount spent by month.
+  This is an example of a database view model. It shows transaction details including date, amount, and description.
+  Description is masked for non-manager users.
 
   Parameters are available to filter the date and amount of the transactions.
 
-connection: default        # optional - if not provided, will use default connection specified in the SQRL_CONNECTIONS__DEFAULT_NAME_USED setting
+connection: default         # optional - if not provided, will use default connection specified in the SQRL_CONNECTIONS__DEFAULT_NAME_USED setting
 
-translate_to_duckdb: true  # optional - default is false - if true, then the model will be translated to duckdb for supported dialects
+translate_to_duckdb: false  # optional - default is false - if true, then the model will be translated to duckdb if dialect is supported by sqlglot
 
-depends_on:                # optional - the "source" macro also adds to this set
+depends_on:                 # optional - Squirrels is able to derive this from the "source" macro in the SQL file
   - src_transactions
 
 columns:
-  - name: month
-    type: string
-    description: The months for which the amount is aggregated by, in descending order
-    category: dimension
+  - name: date
     depends_on:
       - src_transactions.date
+    pass_through: true
   
-  - name: total_amount
+  - name: amount
     type: float
-    description: The total amount spent by the group-by dimension
+    description: The amount of the transaction, formatted to 2 decimal places
     category: measure
     depends_on:
       - src_transactions.amount
+      
+  - name: description
+    type: string
+    description: The description of the transaction (masked for non-manager users)
+    category: dimension
+    depends_on:
+      - src_transactions.description

squirrels/_package_data/base_project/models/federates/federate_example.py

@@ -1,8 +1,8 @@
-from squirrels import arguments as args
+from squirrels.arguments import ModelArgs
 import polars as pl, pandas as pd
 
 
-def main(sqrl: args.ModelArgs) -> pl.LazyFrame | pl.DataFrame | pd.DataFrame:
+def main(sqrl: ModelArgs) -> pl.LazyFrame | pl.DataFrame | pd.DataFrame:
     """
     Create federated models by joining/processing dependent models (sources, seeds, builds, dbviews, other federates, etc.) to
     form a new Python DataFrame (using polars LazyFrame, polars DataFrame, or pandas DataFrame).
@@ -16,26 +16,36 @@ def main(sqrl: args.ModelArgs) -> pl.LazyFrame | pl.DataFrame | pd.DataFrame:
         (pl.col("amount") <= sqrl.ctx["max_amount_from_range"])
     )
 
-    if sqrl.ctx["has_categories"]:
+    if sqrl.ctx.get("has_categories"):
         categories: list[str] = sqrl.ctx["categories"]
         df = df.filter(pl.col("category_id").is_in(categories))
 
-    if sqrl.ctx["has_subcategories"]:
+    if sqrl.ctx.get("has_subcategories"):
         subcategories: list[str] = sqrl.ctx["subcategories"]
         df = df.filter(pl.col("subcategory_id").is_in(subcategories))
 
-    dimension_cols: list[str] = sqrl.ctx["group_by_cols"]
-    df = df.group_by(dimension_cols).agg(
-        pl.sum("amount").cast(pl.Decimal(precision=15, scale=2)).alias("total_amount")
-    )
-    df = df.rename(sqrl.ctx["rename_dict"])
-
-    order_by_cols: list[str] = sqrl.ctx["order_by_cols"]
-    df = df.select(*order_by_cols, "total_amount") \
-        .sort(order_by_cols, descending=True)
-
-    if "limit" in sqrl.ctx:
-        limit: int = sqrl.ctx["limit"]
-        df = df.limit(limit)
+    df = df.rename(sqrl.ctx.get("column_to_alias_mapping", {}))
+
+    dimension_cols: list[str] | None = sqrl.ctx.get("group_by_cols")
+    decimal_type = pl.Decimal(precision=15, scale=2)
+    if dimension_cols is not None:
+        df = df.group_by(dimension_cols).agg(
+            pl.sum("amount").cast(decimal_type).alias("total_amount")
+        )
+    else:
+        df = df.with_columns(
+            pl.col("amount").cast(decimal_type).alias("total_amount")
+        )
+    
+    order_by_cols: list[str] = sqrl.ctx.get("order_by_cols")
+    if order_by_cols is not None:
+        df = df.select(*order_by_cols, "total_amount").sort(order_by_cols, descending=True)
+
+    # Apply mask_column_function to description column if it exists
+    mask_column_func = sqrl.ctx.get("mask_column_function")
+    if "description" in order_by_cols and mask_column_func:
+        df = df.with_columns(
+            pl.col("description").map_elements(mask_column_func, return_dtype=pl.String).alias("description")
+        )
 
     return df

squirrels/_package_data/base_project/models/federates/federate_example.sql

@@ -1,7 +1,7 @@
 {#- DuckDB dialect -#}
 
 SELECT {{ ctx.select_dim_cols | join }}
-    , CAST(SUM(amount) AS DECIMAL(15, 2)) as total_amount
+    , CAST({{ ctx.aggregator }}(amount) AS DECIMAL(15, 2)) as total_amount
 
 {# ref() can be used on a sources, seeds, builds, dbviews, or other federate models -#}
 FROM {{ ref("build_example") }} AS a
@@ -14,12 +14,8 @@ WHERE {{ date_and_amount_filters(use_from_range=true) }}
     AND subcategory_id IN ({{ ctx.subcategories | quote_and_join }}) 
 {%- endif %}
 
+{%- if ctx.group_by_cols %}
 GROUP BY {{ ctx.group_by_cols | join }}
+{%- endif %}
 
 ORDER BY {{ ctx.order_by_cols_desc | join }}
-
-{%- if ctx.limit %}
-
-LIMIT {{ ctx.limit }}
-
-{%- endif %}

squirrels/_package_data/base_project/models/federates/federate_example.yml

@@ -11,7 +11,7 @@ eager: false               # optional - defaults to false. Only applies to SQL m
 columns:
   - name: date
     type: string
-    condition: parameter 'group_by' (Group By) is 'trans' (Transaction)
+    condition: ['group_by == "Transaction"']
     description: The date of the transaction in 'YYYY-MM-DD' format, in descending order
     category: dimension
     depends_on:
@@ -19,15 +19,15 @@ columns:
   
   - name: description
     type: string
-    condition: parameter 'group_by' (Group By) is 'trans' (Transaction)
-    description: The description of the transaction
+    condition: ['group_by == "Transaction"']
+    description: The description of the transaction (masked for non-manager users)
     category: dimension
     depends_on:
       - build_example.description
   
   - name: day
     type: string
-    condition: parameter 'group_by' (Group By) is 'day' (Day)
+    condition: ['group_by == "Day"']
     description: The day for which the amount is aggregated by, in descending order
     category: dimension
     depends_on:
@@ -35,7 +35,7 @@ columns:
   
   - name: month
     type: string
-    condition: parameter 'group_by' (Group By) is 'month' (Month)
+    condition: ['group_by == "Month"']
     description: The month for which the amount is aggregated by, in descending order
     category: dimension
     depends_on:
@@ -43,7 +43,7 @@ columns:
 
   - name: category
     type: string
-    condition: parameter `group_by` (Group By) is `trans` (Transaction), `cat` (Category), or `subcat` (Subcategory)
+    condition: ['group_by == "Transaction"', 'group_by == "Category"', 'group_by == "Subcategory"']
     description: The category for which the amount is aggregated by
     category: dimension
     depends_on:
@@ -51,7 +51,7 @@ columns:
   
   - name: subcategory
     type: string
-    condition: parameter `group_by` (Group By) is `trans` (Transaction) or `subcat` (Subcategory)
+    condition: ['group_by == "Transaction"', 'group_by == "Subcategory"']
     description: The subcategory for which the amount is aggregated by
     category: dimension
     depends_on:

squirrels/_package_data/base_project/models/sources.yml

@@ -3,16 +3,15 @@ sources:
     description: "The source table for transactions"  # optional
     connection: default           # optional - if not provided, will use the connection named "default" or the default connection specified in settings
     table: expenses               # optional - if not provided, will use the "name" field of the source
-    load_to_duckdb: true          # optional - default is false - outside of dbview models that have translate_to_duckdb as false, other models can only reference this source if load_to_duckdb is true
-
-    # For performance reasons, avoid specifying primary_key for large tables if upserts are not required
-    primary_key: [id]             # optional - if not provided, then this is an insert-only table for incremental loads - otherwise, this uses upsert
+    load_to_vdl: true             # optional - default is false - other than dbview models (with translate_to_duckdb set to false), other models can only reference this source if load_to_vdl is true or connection type is duckdb
     
     update_hints:
       increasing_column: date     # optional - if not provided, will always do full refresh, otherwise uses this column for incremental loads
-      strictly_increasing: false  # optional - default is true - if false, then maximum value of column is removed before incremental loads
+      strictly_increasing: false  # optional - default is true - if false, then maximum value of column is removed before incremental load is performed
 
-    columns:                      # optional - if load_to_duckdb is true, then only the columns listed here are loaded to duckdb
+    primary_key: [id]             # optional - if not provided, then this is an insert-only table for incremental loads
+    
+    columns:                      # optional - if load_to_vdl is true, then only the columns listed here are loaded to the Virtual Data Lake (VDL)
       - name: id
         type: string
         description: The unique identifier for the transaction

squirrels/_package_data/base_project/parameters.yml

@@ -5,47 +5,33 @@ parameters:
       name: group_by
       label: Group By
       description: Dimension(s) to aggregate by           ## optional, default is empty string
-      user_attribute: role                                ## optional, default is null
+      user_attribute: access_level                        ## optional, default is null
       all_options:
         - id: trans
           label: Transaction
           columns: ["id", "date", "category", "subcategory", "description"]   ## custom field
           aliases: ["_id", "date", "category", "subcategory", "description"]  ## custom field (any alias starting with "_" will not be selected - see context.py for implementation)
-          is_default: false                               ## optional, default, exists for SingleSelect or MultiSelect options only
-          user_groups: ["manager"]                        ## optional, default is empty list
-          parent_option_ids: []                           ## optional, default, exists for all parameter options
+          is_default: false                               ## optional, shown is default - exists for SingleSelect or MultiSelect options only
+          user_groups: ["admin"]                          ## optional, default is empty list
+          parent_option_ids: []                           ## optional, shown is default - exists for all parameter options
         - id: day
           label: Day
           columns: [date]
           aliases: [day]
-          user_groups: ["manager", "employee"]
+          user_groups: ["admin", "member"]
         - id: month
           label: Month
           columns: [month]
-          user_groups: ["manager", "employee"]
+          user_groups: ["admin", "member", "guest"]
         - id: cat
           label: Category
           columns: [category]
-          user_groups: ["manager", "employee"]
+          user_groups: ["admin", "member", "guest"]
         - id: subcat
           label: Subcategory
           columns: [category, subcategory]
-          user_groups: ["manager", "employee"]
-      parent_name: null                                   ## optional, default, exists for all parameter types
-  
-  - type: NumberParameter
-    factory: CreateWithOptions
-    arguments:
-      name: limit
-      label: Max Number of Rows
-      description: Maximum number of rows to return
-      parent_name: group_by
-      all_options:
-        - min_value: 0
-          max_value: 1000
-          increment: 10
-          default_value: 1000
-          parent_option_ids: trans
+          user_groups: ["admin", "member", "guest"]
+      parent_name: null                                   ## optional, shown is default - exists for all parameter types
   
   - type: DateParameter
     factory: CreateFromSource
@@ -92,14 +78,14 @@ parameters:
         table_or_query: seed_categories
         id_col: category_id
         options_col: category
-        from_seeds: true                                  ## optional, default is false, exists for data_source of any parameters
-        order_by_col: null                                ## optional, default, exists for data_source of SingleSelect and MultiSelect
-        is_default_col: null                              ## optional, default, exists for data_source of SingleSelect and MultiSelect
-        custom_cols: {}                                   ## optional, default, exists for data_source of SingleSelect and MultiSelect
-        include_all: true                                 ## optional, default, exists for data_source of MultiSelect only
-        order_matters: false                              ## optional, default, exists for data_source of MultiSelect only
-        user_group_col: null                              ## optional, default, exists for data_source of any parameters
-        connection_name: default                          ## optional, default, exists for data_source of any parameters
+        source: seeds                                     ## optional, default is "connection" - must be one of "connection", "seeds", or "vdl" - exists for data_source of any parameters
+        order_by_col: null                                ## optional, shown is default - exists for data_source of SingleSelect and MultiSelect
+        is_default_col: null                              ## optional, shown is default - exists for data_source of SingleSelect and MultiSelect
+        custom_cols: {}                                   ## optional, shown is default - exists for data_source of SingleSelect and MultiSelect
+        include_all: true                                 ## optional, shown is default - exists for data_source of MultiSelect only
+        order_matters: false                              ## optional, shown is default - exists for data_source of MultiSelect only
+        user_group_col: null                              ## optional, shown is default - exists for data_source of any parameters
+        connection_name: default                          ## optional, shown is default - exists for data_source of any parameters
   
   - type: MultiSelectParameter
     factory: CreateFromSource
@@ -112,8 +98,8 @@ parameters:
         table_or_query: seed_subcategories
         id_col: subcategory_id
         options_col: subcategory
-        from_seeds: true
-        parent_id_col: category_id                        ## optional, default is null, exists for all parameter types
+        source: seeds
+        parent_id_col: category_id                        ## optional, default is null - exists for all parameter types
   
   - type: NumberParameter
     factory: CreateWithOptions
@@ -124,8 +110,8 @@ parameters:
       all_options:
         - min_value: 0
           max_value: 300
-          increment: 10                                   ## optional, default is 1, exists for Number and NumberRange options
-          default_value: null                             ## optional, default, exists for Number options only
+          increment: 10                                   ## optional, default is 1 - exists for Number and NumberRange options
+          default_value: null                             ## optional, shown is default - exists for Number options only
   
   - type: NumberParameter
     factory: CreateFromSource
@@ -139,7 +125,7 @@ parameters:
         max_value_col: max_value
         increment_col: increment                          ## optional, default is null
         default_value_col: max_value                      ## optional, default is null
-        id_col: null                                      ## optional, default, required for SingleSelect and MultiSelect, optional for others
+        id_col: null                                      ## optional, shown is default - required for SingleSelect and MultiSelect, optional for others
   
   - type: NumberRangeParameter
     factory: CreateWithOptions
@@ -150,7 +136,7 @@ parameters:
       all_options:
         - min_value: 0
           max_value: 300
-          default_lower_value: 0                          ## optional, default is null (or min_value), exists for NumRange options only
-          default_upper_value: 300                        ## optional, default is null (or max_value), exists for NumRange options only
+          default_lower_value: 0                          ## optional, default is null (or min_value) - exists for NumberRange options only
+          default_upper_value: 300                        ## optional, default is null (or max_value) - exists for NumberRange options only
 
 

squirrels/_package_data/base_project/pyconfigs/connections.py

@@ -1,8 +1,9 @@
 from typing import Any
-from squirrels import arguments as args, connections as cn
+from squirrels.arguments import ConnectionsArgs
+from squirrels.connections import ConnectionProperties, ConnectionTypeEnum
 
 
-def main(connections: dict[str, cn.ConnectionProperties | Any], sqrl: args.ConnectionsArgs) -> None:
+def main(connections: dict[str, ConnectionProperties | Any], sqrl: ConnectionsArgs) -> None:
     """
     Define sqlalchemy engines by adding them to the "connections" dictionary
     """
@@ -10,5 +11,9 @@ def main(connections: dict[str, cn.ConnectionProperties | Any], sqrl: args.Conne
     conn_str: str = sqrl.env_vars["SQLITE_URI"].format(project_path=sqrl.project_path)
 
     ## Assigning names to connection engines
-    connections["default"] = cn.ConnectionProperties(label="SQLite Expenses Database", type=cn.ConnectionTypeEnum.SQLALCHEMY, uri=conn_str)
+    connections["default"] = ConnectionProperties(
+        label="SQLite Expenses Database", 
+        type=ConnectionTypeEnum.SQLALCHEMY, 
+        uri=conn_str
+    )