squirrels 0.3.0__py3-none-any.whl → 0.3.2__py3-none-any.whl

squirrels/package_data/base_project/.gitignore

@@ -7,5 +7,6 @@ venv/
 
 # squirrels files to ignore
 environcfg.yml
+env.yml
 target/
 sqrl_packages/

squirrels/package_data/base_project/{environcfg.yml → env.yml}

@@ -16,7 +16,7 @@ users:
 
 ## Custom environment variables / secrets
 env_vars:
-  sqlite_conn_str: sqlite://{username}:{password}@/database/expenses.db
+  sqlite_conn_str: sqlite://{username}:{password}@/./assets/expenses.db
 
 ## Database credentials
 credentials:

squirrels/package_data/base_project/models/dbviews/database_view1.sql

@@ -11,11 +11,10 @@ transactions_with_masked_id AS (
 SELECT {{ ctx.select_dim_cols }}
     , sum(-amount) as total_amount
 FROM transactions_with_masked_id
-WHERE true
-    {% if is_placeholder("start_date") -%} AND date >= :start_date {%- endif %}
-    {% if is_placeholder("end_date") -%} AND date <= :end_date {%- endif %}
-    {% if is_placeholder("min_amount") -%} AND -amount >= :min_amount {%- endif %}
-    {% if is_placeholder("max_amount") -%} AND -amount <= :max_amount {%- endif %}
+WHERE date >= :start_date
+    AND date <= :end_date
+    AND -amount >= :min_amount
+    AND -amount <= :max_amount
     {% if is_placeholder("desc_pattern") -%} AND description LIKE :desc_pattern {%- endif %}
     {% if ctx.has_categories -%} AND category IN ({{ ctx.categories }}) {%- endif %}
     {% if ctx.has_subcategories -%} AND subcategory IN ({{ ctx.subcategories }}) {%- endif %}

squirrels/package_data/base_project/parameters.yml

@@ -1,6 +1,6 @@
 parameters:
   - type: SingleSelectParameter
-    factory: Create                                       ## one of 'Create', 'CreateSimple', or 'CreateFromSource'
+    factory: CreateWithOptions                            ## one of 'CreateSimple', 'CreateWithOptions', or 'CreateFromSource'
     arguments:                                            ## arguments to specify depend on values for 'type' and 'factory'
       name: group_by
       label: Group By
@@ -26,40 +26,40 @@ parameters:
       parent_name: null                                   ## optional, default, exists for all parameter types
   
   - type: TextParameter
-    factory: Create
+    factory: CreateWithOptions
     arguments:
       name: description_filter
       label: Description Contains
-      description: Filter by transactions with this description
+      description: Substring of description to filter transactions by
       parent_name: group_by
       all_options:
         - parent_option_ids: g0
   
   - type: DateParameter
-    factory: Create
+    factory: CreateWithOptions
     arguments:
       name: start_date
       label: Start Date
-      description: Filter by transactions after this date
+      description: Start date to filter transactions by
       all_options:
         - default_date: 2023-01-01
           date_format: '%Y-%m-%d'                         ## optional, default, format comes from python datetime, exists for Date and DateRange parameter options
   
   - type: DateParameter
-    factory: Create
+    factory: CreateWithOptions
     arguments:
       name: end_date
       label: End Date
-      description: Filter by transactions before this date
+      description: End date to filter transactions by
       all_options:
         - default_date: 2023-12-31
   
   - type: DateRangeParameter
-    factory: Create
+    factory: CreateWithOptions
     arguments:
       name: date_range
       label: Date Range
-      description: Filter by transactions within this date range
+      description: Date range to filter transactions by
       all_options:
         - default_start_date: 2023-01-01
           default_end_date: 2023-12-31
@@ -69,7 +69,7 @@ parameters:
     arguments:
       name: category
       label: Category Filter
-      description: The expense categories to filter by
+      description: The expense categories to filter transactions by
       data_source:
         table_or_query: seed_categories
         id_col: category_id
@@ -88,7 +88,7 @@ parameters:
     arguments:
       name: subcategory
       label: Subcategory Filter
-      description: The expense subcategories to filter by (available options based on selected 'Category Filter')
+      description: The expense subcategories to filter transactions by (available options are based on selected value(s) of 'Category Filter')
       parent_name: category
       data_source:
         table_or_query: seed_subcategories
@@ -98,11 +98,11 @@ parameters:
         parent_id_col: category_id                        ## optional, default is null, exists for all parameter types
   
   - type: NumberParameter
-    factory: Create
+    factory: CreateWithOptions
     arguments:
       name: min_filter
       label: Amounts Greater Than
-      description: Filter by transactions greater than this amount
+      description: Number to filter on transactions with an amount greater than this value
       all_options:
         - min_value: 0
           max_value: 500
@@ -114,7 +114,7 @@ parameters:
     arguments:
       name: max_filter
       label: Amounts Less Than
-      description: Filter by transactions less than this amount
+      description: Number to filter on transactions with an amount less than this value
       data_source:
         table_or_query: "SELECT 0 as min_value, max(-amount) as max_value, 10 as increment FROM transactions WHERE category <> 'Income'"
         min_value_col: min_value
@@ -124,11 +124,11 @@ parameters:
         id_col: null                                      ## optional, default, required for SingleSelect and MultiSelect, optional for all others
   
   - type: NumberRangeParameter
-    factory: Create
+    factory: CreateWithOptions
     arguments:
       name: between_filter
       label: Amounts Between
-      description: Filter by transaction amounts within this range
+      description: Number range to filter on transactions with an amount within this range
       all_options:
         - min_value: 0
           max_value: 500

squirrels/package_data/base_project/pyconfigs/connections.py

@@ -8,7 +8,7 @@ def main(connections: dict[str, Engine], sqrl: ConnectionsArgs) -> None:
     """
     
     ## SQLAlchemy URL for a connection engine
-    conn_str = 'sqlite:///database/expenses.db' 
+    conn_str = 'sqlite:///./assets/expenses.db' 
 
     ## Can also leverage environment variables and credentials in the environcfg.yml file for connection details
     # conn_str_raw: str = sqrl.env_vars["sqlite_conn_str"]

squirrels/package_data/base_project/pyconfigs/parameters.py

@@ -6,14 +6,14 @@ def main(sqrl: ParametersArgs) -> None:
     Create all widget parameters in this file. If two or more datasets use a different set of parameters, define them all
     here, and specify the subset of parameters used for each dataset in the "squirrels.yml" file.
 
-    Parameters are created by a factory method associated to some parameters class. For example (note the "Create"):
-    > p.SingleSelectParameter.Create(...)
+    Parameters are created by a factory method associated to the parameter class. For example, "CreateWithOptions" is the factory method used here:
+    > p.SingleSelectParameter.CreateWithOptions(...)
 
     The parameter classes available are:
     - SingleSelectParameter, MultiSelectParameter, DateParameter, DateRangeParameter, NumberParameter, NumberRangeParameter, TextParameter
     
     The factory methods available are:
-    - Create, CreateSimple, CreateFromSource
+    - CreateSimple, CreateWithOptions, CreateFromSource
     """
 
     ## Example of creating SingleSelectParameter and specifying each option by code
@@ -23,38 +23,38 @@ def main(sqrl: ParametersArgs) -> None:
         po.SelectParameterOption("g2", "Category", columns=["category"]),
         po.SelectParameterOption("g3", "Subcategory", columns=["category", "subcategory"]),
     ]
-    p.SingleSelectParameter.Create(
-        "group_by", "Group By", group_by_options, description="Dimension to aggregate by"
+    p.SingleSelectParameter.CreateWithOptions(
+        "group_by", "Group By", group_by_options, description="Dimension(s) to aggregate by"
     )
 
     ## Example of creating a TextParameter
     parent_name = "group_by"
     text_options = [po.TextParameterOption(parent_option_ids="g0")]
-    p.TextParameter.Create(
+    p.TextParameter.CreateWithOptions(
         "description_filter", "Description Contains", text_options, parent_name=parent_name,
-        description="Filter by transactions with this description"
+        description="Substring of description to filter transactions by"
     )
 
     ## Example of creating DateParameter
     p.DateParameter.CreateSimple(
-        "start_date", "Start Date", "2023-01-01", description="Filter by transactions after this date"
+        "start_date", "Start Date", "2023-01-01", description="Start date to filter transactions by"
     )
 
     ## Example of creating DateParameter from list of DateParameterOption's
     end_date_option = [po.DateParameterOption("2023-12-31")]
-    p.DateParameter.Create(
-        "end_date", "End Date", end_date_option, description="Filter by transactions before this date"
+    p.DateParameter.CreateWithOptions(
+        "end_date", "End Date", end_date_option, description="End date to filter transactions by"
     )
 
     ## Example of creating DateRangeParameter
     p.DateRangeParameter.CreateSimple(
-        "date_range", "Date Range", "2023-01-01", "2023-12-31", description="Filter by transactions within this date range"
+        "date_range", "Date Range", "2023-01-01", "2023-12-31", description="Date range to filter transactions by"
     )
 
     ## Example of creating MultiSelectParameter from lookup query/table
     category_ds = ds.SelectDataSource("seed_categories", "category_id", "category", from_seeds=True)
     p.MultiSelectParameter.CreateFromSource(
-        "category", "Category Filter", category_ds, description="The expense categories to filter by"
+        "category", "Category Filter", category_ds, description="The expense categories to filter transactions by"
     )
 
     ## Example of creating MultiSelectParameter with parent from lookup query/table
@@ -64,24 +64,24 @@ def main(sqrl: ParametersArgs) -> None:
     )
     p.MultiSelectParameter.CreateFromSource(
         "subcategory", "Subcategory Filter", subcategory_ds, parent_name=parent_name,
-        description="The expense subcategories to filter by (available options based on selected 'Category Filter')"
+        description="The expense subcategories to filter transactions by (available options are based on selected value(s) of 'Category Filter')"
     )
 
     ## Example of creating NumberParameter
     p.NumberParameter.CreateSimple(
         "min_filter", "Amounts Greater Than", min_value=0, max_value=500, increment=10,
-        description="Filter by transactions greater than this amount"
+        description="Number to filter on transactions with an amount greater than this value"
     )
     
     ## Example of creating NumberParameter from lookup query/table
     query = "SELECT 0 as min_value, max(-amount) as max_value, 10 as increment FROM transactions WHERE category <> 'Income'"
     max_amount_ds = ds.NumberDataSource(query, "min_value", "max_value", increment_col="increment", default_value_col="max_value")
     p.NumberParameter.CreateFromSource(
-        "max_filter", "Amounts Less Than", max_amount_ds, description="Filter by transactions less than this amount"
+        "max_filter", "Amounts Less Than", max_amount_ds, description="Number to filter on transactions with an amount less than this value"
     )
 
     ## Example of creating NumberRangeParameter
     p.NumberRangeParameter.CreateSimple(
         "between_filter", "Amounts Between", 0, 500, default_lower_value=10, default_upper_value=400,
-        description="Filter by transaction amounts within this range"
+        description="Number range to filter on transactions with an amount within this range"
     )

squirrels/package_data/base_project/squirrels.yml.j2

@@ -51,7 +51,7 @@ selection_test_sets:
   - name: no_auth_test1
     datasets:                             ## optional section - if not provided, then test set is applicable for any dataset
       - dataset_example
-    parameters:                           ## optional section - for unspecified parameters, default value is used
+    parameters:                           ## optional section - if not provided, then assumes no parameters. For unspecified parameters, default value is used
       start_date: 2023-07-01              ## this parameter only exists for dataset 'dataset_example'
   
   - name: auth_test1

squirrels/parameter_options.py

@@ -3,6 +3,7 @@ from dataclasses import dataclass, field
 from decimal import Decimal, InvalidOperation as InvalidDecimalConversion
 from datetime import datetime, date
 from abc import ABCMeta, abstractmethod
+import re
 
 from ._utils import ConfigurationError
 
@@ -214,9 +215,9 @@ class _NumericParameterOption(ParameterOption):
     ) -> None:
         super().__init__(user_groups=user_groups, parent_option_ids=parent_option_ids)
         try:
-            self._min_value = Decimal(min_value)
-            self._max_value = Decimal(max_value)
-            self._increment = Decimal(increment)
+            self._min_value = Decimal(str(min_value))
+            self._max_value = Decimal(str(max_value))
+            self._increment = Decimal(str(increment))
         except InvalidDecimalConversion as e:
             raise ConfigurationError(f'Could not convert either min, max, or increment to number') from e
         
@@ -235,7 +236,7 @@ class _NumericParameterOption(ParameterOption):
 
     def _validate_value(self, value: Number) -> Decimal:
         try:
-            value = Decimal(value)
+            value = Decimal(str(value))
         except InvalidDecimalConversion as e:
             raise ConfigurationError(f'Could not convert "{value}" to number', e)