squirrels 0.5.0b2__py3-none-any.whl → 0.5.0b4__py3-none-any.whl

squirrels/{package_data → _package_data}/base_project/parameters.yml

@@ -7,26 +7,27 @@ parameters:
       description: Dimension(s) to aggregate by           ## optional, default is empty string
       user_attribute: role                                ## optional, default is null
       all_options:
-        - id: g0
+        - id: trans
           label: Transaction
-          columns: ["date", "category", "subcategory", "description"]   ## custom field
+          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
-        - id: g1
+        - id: day
           label: Day
           columns: [date]
-          aliases: [day]                                  ## custom field
+          aliases: [day]
           user_groups: ["manager", "employee"]
-        - id: g4
+        - id: month
           label: Month
           columns: [month]
           user_groups: ["manager", "employee"]
-        - id: g2
+        - id: cat
           label: Category
           columns: [category]
           user_groups: ["manager", "employee"]
-        - id: g3
+        - id: subcat
           label: Subcategory
           columns: [category, subcategory]
           user_groups: ["manager", "employee"]
@@ -44,7 +45,7 @@ parameters:
           max_value: 1000
           increment: 10
           default_value: 1000
-          parent_option_ids: g0
+          parent_option_ids: trans
   
   - type: DateParameter
     factory: CreateFromSource

squirrels/_package_data/base_project/pyconfigs/connections.py

@@ -0,0 +1,14 @@
+from typing import Any
+from squirrels import arguments as args, connections as cn
+
+
+def main(connections: dict[str, cn.ConnectionProperties | Any], sqrl: args.ConnectionsArgs) -> None:
+    """
+    Define sqlalchemy engines by adding them to the "connections" dictionary
+    """
+    ## SQLAlchemy URL for a connection engine
+    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)
+    

squirrels/{package_data → _package_data}/base_project/pyconfigs/context.py

@@ -1,8 +1,8 @@
 from typing import Any
-from squirrels import ContextArgs, parameters as p
+from squirrels import arguments as args, parameters as p
 
 
-def main(ctx: dict[str, Any], sqrl: ContextArgs) -> None:
+def main(ctx: dict[str, Any], sqrl: args.ContextArgs) -> None:
     """
     Define context variables AFTER parameter selections are made by adding entries to the dictionary "ctx". 
     These context variables can then be used in the models.
@@ -18,52 +18,50 @@ def main(ctx: dict[str, Any], sqrl: ContextArgs) -> None:
         aliases = group_by_param.get_selected("aliases", default_field="columns")
         assert isinstance(columns, list) and isinstance(aliases, list) and len(columns) == len(aliases)
 
-        ctx["select_dim_cols"] = ", ".join(x+" as "+y for x, y in zip(columns, aliases))
-        ctx["group_by_cols"] = ", ".join(columns)
-        ctx["order_by_cols"] = ", ".join((x+" DESC") for x in aliases)
-        ctx["group_by_cols_list"] = columns
-        ctx["rename_dict"] = {old: new for old, new in zip(columns, aliases)}
+        ctx["group_by_cols"] = columns
+        ctx["rename_dict"] = {x: y for x, y in zip(columns, aliases) if not y.startswith("_")}
+        ctx["select_dim_cols"] = list(x+" as "+y for x, y in ctx["rename_dict"].items())
+        ctx["order_by_cols"] = list(ctx["rename_dict"].values())
+        ctx["order_by_cols_desc"] = list(x+" DESC" for x in ctx["order_by_cols"])
     
     if sqrl.param_exists("limit"):
         limit_param = sqrl.prms["limit"]
         assert isinstance(limit_param, p.NumberParameter)
 
-        ctx["limit_clause"] = f"LIMIT {limit_param.get_selected_value()}"
-    else:
-        ctx["limit_clause"] = ""
+        ctx["limit"] = int(limit_param.get_selected_value())
 
     if sqrl.param_exists("start_date"):
         start_date_param = sqrl.prms["start_date"]
         assert isinstance(start_date_param, p.DateParameter)
 
-        ctx["start_date"] = start_date_param.get_selected_date_quoted()
+        ctx["start_date"] = start_date_param.get_selected_date()
     
     if sqrl.param_exists("end_date"):
         end_date_param = sqrl.prms["end_date"]
         assert isinstance(end_date_param, p.DateParameter)
 
-        ctx["end_date"] = end_date_param.get_selected_date_quoted()
+        ctx["end_date"] = end_date_param.get_selected_date()
 
     if sqrl.param_exists("date_range"):
         date_range_param = sqrl.prms["date_range"]
         assert isinstance(date_range_param, p.DateRangeParameter)
 
-        ctx["start_date_from_range"] = date_range_param.get_selected_start_date_quoted()
-        ctx["end_date_from_range"] = date_range_param.get_selected_end_date_quoted()
+        ctx["start_date_from_range"] = date_range_param.get_selected_start_date()
+        ctx["end_date_from_range"] = date_range_param.get_selected_end_date()
     
     if sqrl.param_exists("category"):
         category_param = sqrl.prms["category"]
         assert isinstance(category_param, p.MultiSelectParameter)
 
         ctx["has_categories"] = category_param.has_non_empty_selection()
-        ctx["categories"] = category_param.get_selected_ids_quoted_joined()
+        ctx["categories"] = category_param.get_selected_ids_as_list()
     
     if sqrl.param_exists("subcategory"):
         subcategory_param = sqrl.prms["subcategory"]
         assert isinstance(subcategory_param, p.MultiSelectParameter)
 
         ctx["has_subcategories"] = subcategory_param.has_non_empty_selection()
-        ctx["subcategories"] = subcategory_param.get_selected_ids_quoted_joined()
+        ctx["subcategories"] = subcategory_param.get_selected_ids_as_list()
     
     if sqrl.param_exists("min_filter"):
         min_amount_filter = sqrl.prms["min_filter"]

squirrels/_package_data/base_project/pyconfigs/parameters.py

@@ -0,0 +1,106 @@
+from squirrels import arguments as args, parameters as p, parameter_options as po, data_sources as ds
+
+
+## Example of creating SingleSelectParameter and specifying each option by code
+@p.SingleSelectParameter.create_with_options(
+    "group_by", "Group By", description="Dimension(s) to aggregate by", user_attribute="role"
+)
+def group_by_options():
+    return [
+        po.SelectParameterOption(
+            "trans", "Transaction",  
+            columns=["id","date","category","subcategory","description"],
+            aliases=["_id","date","category","subcategory","description"], # any alias starting with "_" will not be selected - see context.py for implementation
+            user_groups=["manager"]
+        ),
+        po.SelectParameterOption("day"    , "Day"         , columns=["date"], aliases=["day"]   , user_groups=["manager","employee"]),
+        po.SelectParameterOption("month"  , "Month"       , columns=["month"]                   , user_groups=["manager","employee"]),
+        po.SelectParameterOption("cat"    , "Category"    , columns=["category"]                , user_groups=["manager","employee"]),
+        po.SelectParameterOption("subcat" , "Subcategory" , columns=["category","subcategory"]  , user_groups=["manager","employee"]),
+    ]
+
+
+## Example of creating NumberParameter with options
+@p.NumberParameter.create_with_options(
+    "limit", "Max Number of Rows", description="Maximum number of rows to return", parent_name="group_by"
+)
+def limit_options():
+    return [po.NumberParameterOption(0, 1000, increment=10, default_value=1000, parent_option_ids="trans")]
+
+
+## Example of creating DateParameter
+@p.DateParameter.create_from_source(
+    "start_date", "Start Date", description="Start date to filter transactions by"
+)
+def start_date_source():
+    return ds.DateDataSource(
+        "SELECT min(date) AS min_date, max(date) AS max_date FROM expenses",
+        default_date_col="min_date", min_date_col="min_date", max_date_col="max_date"
+    )
+
+
+## Example of creating DateParameter from list of DateParameterOption's
+@p.DateParameter.create_with_options(
+    "end_date", "End Date", description="End date to filter transactions by"
+)
+def end_date_options():
+    return [po.DateParameterOption("2024-12-31", min_date="2024-01-01", max_date="2024-12-31")]
+
+
+## Example of creating DateRangeParameter
+@p.DateRangeParameter.create_simple(
+    "date_range", "Date Range", "2024-01-01", "2024-12-31", min_date="2024-01-01", max_date="2024-12-31",
+    description="Date range to filter transactions by"
+)
+def date_range_options():
+    pass
+
+
+## Example of creating MultiSelectParameter from lookup query/table
+@p.MultiSelectParameter.create_from_source(
+    "category", "Category Filter", 
+    description="The expense categories to filter transactions by"
+)
+def category_source():
+    return ds.SelectDataSource("seed_categories", "category_id", "category", from_seeds=True)
+
+
+## Example of creating MultiSelectParameter with parent from lookup query/table
+@p.MultiSelectParameter.create_from_source(
+    "subcategory", "Subcategory Filter", parent_name="category",
+    description="The expense subcategories to filter transactions by (available options are based on selected value(s) of 'Category Filter')"
+)
+def subcategory_source():
+    return ds.SelectDataSource(
+        "seed_subcategories", "subcategory_id", "subcategory", from_seeds=True, parent_id_col="category_id"
+    )
+
+
+## Example of creating NumberParameter
+@p.NumberParameter.create_simple(
+    "min_filter", "Amounts Greater Than", min_value=0, max_value=300, increment=10,
+    description="Number to filter on transactions with an amount greater than this value"
+)
+def min_filter_options():
+    pass
+
+
+## Example of creating NumberParameter from lookup query/table
+@p.NumberParameter.create_from_source(
+    "max_filter", "Amounts Less Than",
+    description="Number to filter on transactions with an amount less than this value"
+)
+def max_filter_source():
+    query = "SELECT 0 as min_value, 300 as max_value, 10 as increment"
+    return ds.NumberDataSource(
+        query, "min_value", "max_value", increment_col="increment", default_value_col="max_value"
+    )
+
+
+## Example of creating NumberRangeParameter
+@p.NumberRangeParameter.create_simple(
+    "between_filter", "Amounts Between", min_value=0, max_value=300, default_lower_value=0, default_upper_value=300,
+    description="Number range to filter on transactions with an amount within this range"
+)
+def between_filter_options():
+    pass

squirrels/_package_data/base_project/pyconfigs/user.py

@@ -0,0 +1,51 @@
+from typing import Literal
+from squirrels import auth, arguments as args
+
+
+class User(auth.BaseUser):
+    """
+    Extend the BaseUser class with custom attributes. The attributes defined here will be added as columns to the users table. 
+    - Only the following types are supported: [str, int, float, bool, typing.Literal]
+    - For str, int, and float types, add "| None" after the type to make it nullable. 
+    - Always set a default value for the column (use None if default is null).
+    
+    Example:
+        organization: str | None = None
+    """
+    role: Literal["manager", "employee"] = "employee"
+
+    @classmethod
+    def dropped_columns(cls) -> list[str]:
+        """
+        The fields defined above cannot be modified once added to the database. 
+        However, you can choose to drop columns by adding them to this list.
+        """
+        return []
+
+
+# @auth.provider(name="google", label="Google", icon="https://www.google.com/favicon.ico")
+def google_auth_provider(sqrl: args.AuthProviderArgs) -> auth.ProviderConfigs:
+    """
+    Provider configs for authenticating a user using Google credentials.
+
+    See the following page for setting up the CLIENT_ID and CLIENT_SECRET for Google specifically: 
+    https://support.google.com/googleapi/answer/6158849?hl=en
+    """
+    def get_sqrl_user(claims: dict) -> User:
+        return User(
+            username=claims["email"],
+            is_admin=False,
+            role="employee"
+        )
+
+    # TODO: Add GOOGLE_CLIENT_ID and GOOGLE_CLIENT_SECRET to the .env file
+    # Then, uncomment the @auth.provider decorator above and set the client_id and client_secret below
+    provider_configs = auth.ProviderConfigs(
+        client_id="", # sqrl.env_vars["GOOGLE_CLIENT_ID"],
+        client_secret="", # sqrl.env_vars["GOOGLE_CLIENT_SECRET"],
+        server_metadata_url="https://accounts.google.com/.well-known/openid-configuration",
+        client_kwargs={"scope": "openid email profile"},
+        get_user=get_sqrl_user
+    )
+
+    return provider_configs

squirrels/_package_data/templates/dataset_results.html

@@ -0,0 +1,112 @@
+<style>
+    .dataset-results {
+        font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', sans-serif;
+        background: white;
+        border-radius: 8px;
+        box-shadow: 0 2px 8px rgba(0, 0, 0, 0.1);
+        overflow: hidden;
+        max-width: 100%;
+    }
+
+    .dataset-results .table-container {
+        overflow: auto;
+        max-height: 400px;
+        background: white;
+    }
+
+    .dataset-results .data-table {
+        width: 100%;
+        border-collapse: collapse;
+        font-size: 13px;
+    }
+
+    .dataset-results .data-table thead {
+        background: #f8f9fa;
+        position: sticky;
+        top: 0;
+        z-index: 10;
+    }
+
+    .dataset-results .data-table th {
+        padding: 8px 12px;
+        text-align: left;
+        font-weight: 600;
+        color: #374151;
+        border-bottom: 2px solid #e1e5e9;
+        white-space: nowrap;
+        font-size: 12px;
+    }
+
+    .dataset-results .data-table th .column-type {
+        display: block;
+        font-size: 10px;
+        color: #6b7280;
+        font-weight: 400;
+        margin-top: 1px;
+    }
+
+    .dataset-results .data-table td {
+        padding: 8px 12px;
+        border-bottom: 1px solid #f3f4f6;
+        color: #374151;
+        vertical-align: top;
+        font-size: 12px;
+    }
+
+    .dataset-results .data-table tbody tr:hover {
+        background: #f8f9fa;
+    }
+
+    .dataset-results .data-table tbody tr:nth-child(even) {
+        background: #fafbfc;
+    }
+
+    .dataset-results .data-table tbody tr:nth-child(even):hover {
+        background: #f1f3f4;
+    }
+
+    .dataset-results .empty-state {
+        text-align: center;
+        padding: 40px 20px;
+        color: #6b7280;
+    }
+
+    .dataset-results .empty-state h3 {
+        font-size: 16px;
+        margin-bottom: 6px;
+        color: #374151;
+    }
+</style>
+
+<div class="dataset-results">
+    {% if schema.fields and data %}
+    <div class="table-container">
+        <table class="data-table">
+            <thead>
+                <tr>
+                    {% for field in schema.fields %}
+                    <th>
+                        {{ field.name }}
+                        <span class="column-type">{{ field.type | upper }}</span>
+                    </th>
+                    {% endfor %}
+                </tr>
+            </thead>
+            <tbody>
+                {% for row in data %}
+                <tr>
+                    {% for cell in row %}
+                    <td>{{ cell if cell is not none else '' }}</td>
+                    {% endfor %}
+                </tr>
+                {% endfor %}
+            </tbody>
+        </table>
+    </div>
+    {% else %}
+    <div class="empty-state">
+        <h3>No Data Available</h3>
+        <p>This dataset returned no results.</p>
+    </div>
+    {% endif %}
+</div> 

squirrels/_package_data/templates/oauth_login.html

@@ -0,0 +1,271 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Login - OAuth Authorization</title>
+    <style>
+        * {
+            margin: 0;
+            padding: 0;
+            box-sizing: border-box;
+        }
+
+        body {
+            font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', 'Roboto', sans-serif;
+            background: #f5f7fa;
+            min-height: 100vh;
+            display: flex;
+            align-items: center;
+            justify-content: center;
+            padding: 20px;
+        }
+
+        .login-container {
+            background: white;
+            border-radius: 12px;
+            box-shadow: 0 20px 40px rgba(0, 0, 0, 0.1);
+            padding: 40px;
+            width: 100%;
+            max-width: 450px;
+            position: relative;
+        }
+
+        .logo {
+            text-align: center;
+            margin-bottom: 30px;
+        }
+
+        .logo h1 {
+            color: #1f2937;
+            font-size: 24px;
+            font-weight: 700;
+            margin-bottom: 8px;
+            line-height: 1.3;
+        }
+
+        .logo .brand {
+            color: #1f2937;
+            font-weight: 700;
+        }
+
+        .logo .project {
+            color: #6b7280;
+            font-weight: 600;
+            font-size: 20px;
+        }
+
+        .logo p {
+            color: #6b7280;
+            font-size: 14px;
+        }
+
+        .client-info {
+            background: #f8f9fa;
+            border-radius: 8px;
+            padding: 16px;
+            margin-bottom: 24px;
+            border-left: 4px solid #2563eb;
+        }
+
+        .client-info h3 {
+            color: #333;
+            font-size: 16px;
+            margin-bottom: 4px;
+        }
+
+        .client-info p {
+            color: #666;
+            font-size: 14px;
+        }
+
+        .form-group {
+            margin-bottom: 20px;
+        }
+
+        .form-group label {
+            display: block;
+            margin-bottom: 6px;
+            color: #333;
+            font-weight: 500;
+            font-size: 14px;
+        }
+
+        .form-group input {
+            width: 100%;
+            padding: 12px 16px;
+            border: 2px solid #e1e5e9;
+            border-radius: 8px;
+            font-size: 16px;
+            transition: border-color 0.3s ease;
+            background-color: #fff;
+        }
+
+        .form-group input:focus {
+            outline: none;
+            border-color: #2563eb;
+            box-shadow: 0 0 0 3px rgba(37, 99, 235, 0.1);
+        }
+
+        .btn {
+            width: 100%;
+            padding: 12px 16px;
+            border: none;
+            border-radius: 8px;
+            font-size: 16px;
+            font-weight: 600;
+            cursor: pointer;
+            transition: all 0.3s ease;
+            text-decoration: none;
+            display: inline-block;
+            text-align: center;
+        }
+
+        .btn-primary {
+            background: #2563eb;
+            color: white;
+        }
+
+        .btn-primary:hover {
+            background: #1d4ed8;
+            transform: translateY(-1px);
+            box-shadow: 0 4px 12px rgba(37, 99, 235, 0.3);
+        }
+
+        .btn-provider {
+            background: #fff;
+            color: #333;
+            border: 2px solid #e1e5e9;
+            margin-bottom: 12px;
+            display: flex;
+            align-items: center;
+            justify-content: center;
+            gap: 12px;
+        }
+
+        .btn-provider:hover {
+            border-color: #2563eb;
+            background: #f8f9fa;
+            transform: translateY(-1px);
+        }
+
+        .provider-icon {
+            width: 20px;
+            height: 20px;
+            border-radius: 50%;
+        }
+
+        .divider {
+            text-align: center;
+            margin: 24px 0;
+            position: relative;
+            color: #666;
+            font-size: 14px;
+        }
+
+        .divider::before {
+            content: '';
+            position: absolute;
+            top: 50%;
+            left: 0;
+            right: 0;
+            height: 1px;
+            background: #e1e5e9;
+            z-index: 1;
+        }
+
+        .divider span {
+            background: white;
+            padding: 0 16px;
+            position: relative;
+            z-index: 2;
+        }
+
+        .error-message {
+            background: #fee;
+            border: 1px solid #fcc;
+            color: #c33;
+            padding: 12px;
+            border-radius: 8px;
+            margin-bottom: 20px;
+            font-size: 14px;
+        }
+
+        .info-message {
+            background: #e3f2fd;
+            border: 1px solid #bbdefb;
+            color: #1976d2;
+            padding: 12px;
+            border-radius: 8px;
+            margin-bottom: 20px;
+            font-size: 14px;
+        }
+
+        @media (max-width: 480px) {
+            .login-container {
+                padding: 24px;
+            }
+            
+            .logo h1 {
+                font-size: 24px;
+            }
+        }
+    </style>
+</head>
+<body>
+    <div class="login-container">
+        <div class="logo">
+            <h1>
+                <span class="brand">Squirrels Project</span>
+                {% if project_name %}
+                <br>
+                <span class="project">{{ project_name }}</span>
+                {% endif %}
+            </h1>
+            <p>Please sign in to continue</p>
+        </div>
+
+        {% if client_name %}
+        <div class="client-info">
+            <h3>{{ client_name }}</h3>
+            <p>wants to access your account</p>
+        </div>
+        {% endif %}
+
+        <!-- Username/Password Login Form -->
+        <form method="post" action="{{ login_url }}?redirect_url={{ return_url | urlencode }}">
+            <div class="form-group">
+                <label for="username">Username</label>
+                <input type="text" id="username" name="username" required autocomplete="username">
+            </div>
+            
+            <div class="form-group">
+                <label for="password">Password</label>
+                <input type="password" id="password" name="password" required autocomplete="current-password">
+            </div>
+
+            <input type="hidden" name="redirect_url" value="{{ return_url }}">
+            
+            <button type="submit" class="btn btn-primary">
+                Sign In
+            </button>
+        </form>
+        
+        {% if providers and providers|length > 0 %}
+        <div class="divider">
+            <span>or</span>
+        </div>
+        
+        <!-- OAuth Provider Login Options -->
+        <div class="providers-section">
+            {% for provider in providers %}
+            <a href="{{ provider.login_url }}?redirect_url={{ return_url | urlencode }}" class="btn btn-provider">
+                <img src="{{ provider.icon }}" alt="{{ provider.label }}" class="provider-icon" onerror="this.style.display='none'">
+                <span>Continue with {{ provider.label }}</span>
+            </a>
+            {% endfor %}
+        </div>
+        {% endif %}
+    </div>
+</body>
+</html>