squirrels 0.5.0rc0__py3-none-any.whl → 0.5.1__py3-none-any.whl

squirrels/_package_data/base_project/pyconfigs/parameters.py

@@ -0,0 +1,141 @@
+from squirrels import 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(
+    name="group_by", label="Group By", 
+    description="Dimension(s) to aggregate by", 
+    user_attribute="access_level"
+)
+def group_by_options():
+    return [
+        po.SelectParameterOption(
+            id="trans", label="Transaction",  
+            columns=["id","date","category","subcategory","description"],
+            aliases=["_id","date","category","subcategory","description"], # in context.py, any alias starting with "_" will not be selected
+            user_groups=["admin"]
+        ),
+        po.SelectParameterOption(
+            id="day", label="Day", 
+            columns=["date"], 
+            aliases=["day"], 
+            user_groups=["admin","member"]
+        ),
+        po.SelectParameterOption(
+            id="month", label="Month", 
+            columns=["month"], 
+            user_groups=["admin","member","guest"]
+        ),
+        po.SelectParameterOption(
+            id="cat", label="Category", 
+            columns=["category"], 
+            user_groups=["admin","member","guest"]
+        ),
+        po.SelectParameterOption(
+            id="subcat", label="Subcategory", 
+            columns=["category","subcategory"], 
+            user_groups=["admin","member","guest"]
+        ),
+    ]
+
+
+## Example of creating DateParameter
+@p.DateParameter.create_from_source(
+    name="start_date", label="Start Date", 
+    description="Start date to filter transactions by"
+)
+def start_date_source():
+    return ds.DateDataSource(
+        table_or_query="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(
+    name="end_date", label="End Date", 
+    description="End date to filter transactions by"
+)
+def end_date_options():
+    return [
+        po.DateParameterOption(
+            default_date="2024-12-31", min_date="2024-01-01", max_date="2024-12-31"
+        )
+    ]
+
+
+## Example of creating DateRangeParameter
+@p.DateRangeParameter.create_simple(
+    name="date_range", label="Date Range", 
+    default_start_date="2024-01-01", default_end_date="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(
+    name="category", label="Category Filter", 
+    description="The expense categories to filter transactions by"
+)
+def category_source():
+    return ds.SelectDataSource(
+        table_or_query="seed_categories", 
+        id_col="category_id", 
+        options_col="category", 
+        source=ds.SourceEnum.SEEDS
+    )
+
+
+## Example of creating MultiSelectParameter with parent from lookup query/table
+@p.MultiSelectParameter.create_from_source(
+    name="subcategory", label="Subcategory Filter",
+    description="The expense subcategories to filter transactions by (available options are based on selected value(s) of 'Category Filter')", 
+    parent_name="category"
+)
+def subcategory_source():
+    return ds.SelectDataSource(
+        table_or_query="seed_subcategories", 
+        id_col="subcategory_id", 
+        options_col="subcategory", 
+        source=ds.SourceEnum.SEEDS, 
+        parent_id_col="category_id"
+    )
+
+
+## Example of creating NumberParameter
+@p.NumberParameter.create_simple(
+    name="min_filter", label="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(
+    name="max_filter", label="Amounts Less Than",
+    description="Number to filter on transactions with an amount less than this value"
+)
+def max_filter_source():
+    return ds.NumberDataSource(
+        table_or_query="SELECT 0 as min_value, 300 as max_value, 10 as increment",
+        min_value_col="min_value", max_value_col="max_value", 
+        increment_col="increment", 
+        default_value_col="max_value"
+    )
+
+
+## Example of creating NumberRangeParameter
+@p.NumberRangeParameter.create_simple(
+    name="between_filter", label="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,44 @@
+from typing import Literal
+from squirrels import auth, arguments as args
+
+
+class CustomUserFields(auth.CustomUserFields):
+    """
+    Extend the CustomUserFields class to add custom user attributes. 
+    - Only the following types are supported: [str, int, float, bool, typing.Literal]
+    - Add "| None" after the type to make it nullable. 
+    - Always set a default value for the field (use None if default is null).
+    
+    Example:
+        organization: str | None = None
+    """
+    role: Literal["manager", "staff", "customer"] = "staff"
+
+
+# @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) -> auth.RegisteredUser:
+        custom_fields = CustomUserFields(role="customer")
+        return auth.RegisteredUser(
+            username=claims["email"],
+            access_level="member",
+            custom_fields=custom_fields
+        )
+
+    # 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_url="https://accounts.google.com",
+        client_kwargs={"scope": "openid email profile"},
+        get_user=get_sqrl_user
+    )
+
+    return provider_configs

squirrels/{package_data → _package_data}/base_project/seeds/seed_categories.yml

@@ -1,7 +1,7 @@
 description: |
   Lookup table for the category IDs and names of transactions.
 
-cast_column_types: true  # optional, default is false - setting SQRL_SEEDS__INFER_SCHEMA is ignored for this seed if this is set to true
+cast_column_types: true  # optional, default is false - if set to true, then SQRL_SEEDS__INFER_SCHEMA is ignored for this seed
 
 columns:
   - name: category_id

squirrels/{package_data → _package_data}/base_project/seeds/seed_subcategories.yml

@@ -1,7 +1,7 @@
 description: |
   Lookup table for the subcategory IDs and names of transactions.
 
-cast_column_types: true  # optional, default is false - setting SQRL_SEEDS__INFER_SCHEMA is ignored for this seed if this is set to true
+cast_column_types: true  # optional, default is false - if set to true, then SQRL_SEEDS__INFER_SCHEMA is ignored for this seed
 
 columns:
   - name: subcategory_id

squirrels/_package_data/base_project/squirrels.yml.j2

@@ -0,0 +1,61 @@
+project_variables:
+  name: sample_expenses
+  label: "Sample Expenses"
+  description: This is a sample squirrels project for analyzing expense transactions
+  major_version: 1
+
+
+packages: []
+
+## Example for packages section:
+# packages:
+#   - git: https://.../myrepo.git
+#     revision: v0.1.0
+#     directory: custom_name ## optional
+
+
+{{ connections -}}
+
+
+{{ parameters -}}
+
+
+datasets:
+  - name: expense_transactions           ## model name uses same name unless "model" field is specified
+    label: Expense Transactions - DBView Example
+    description: All expense transactions
+    model: dbview_example 
+    scope: private                        ## optional - one of 'public' (default), 'protected', or 'private'
+    parameters:                           ## optional - if not specified, then all parameters are used
+      - start_date
+      - end_date
+      - min_filter
+      - max_filter
+  
+  - name: grouped_expenses
+    label: Grouped Expenses - Federate Example
+    description: Aggregated expense transactions by custom dimension using federate_example model
+    model: federate_example 
+    scope: public                         ## using an auth.py file is suggested for protected or private datasets
+    parameters:
+      - group_by
+      - date_range
+      - category
+      - subcategory
+      - between_filter
+
+
+selection_test_sets:
+  - name: set_start_date
+    parameters:                           ## optional section - if not provided, then default value is used for all parameters
+      start_date: 2024-07-01              ## this parameter is only used by model "dbview_example"
+  
+  - name: set_date_range
+    parameters:
+      date_range: [2024-02-01,2024-11-30] ## this parameter is only used by model "federate_example"
+    
+  - name: use_admin_privileged_group_by
+    user:
+      access_level: admin
+    parameters:
+      group_by: trans

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> 

squirrels/_package_data/templates/squirrels_studio.html

@@ -0,0 +1,20 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link id="favicon" rel="icon" type="image/x-icon" href="{{ sqrl_studio_base_url }}/favicon.ico" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Squirrels Studio</title>
+    <script>
+      // Optional: Set global defaults for project parameters
+      window.DEFAULT_HOSTNAME = '';
+      window.DEFAULT_PROJECT_NAME = '{{ project_name }}';
+      window.DEFAULT_PROJECT_VERSION = '{{ project_version }}';
+    </script>
+    <script type="module" crossorigin src="{{ sqrl_studio_base_url }}/assets/index.js"></script>
+    <link rel="stylesheet" crossorigin href="{{ sqrl_studio_base_url }}/assets/index.css">
+  </head>
+  <body>
+    <div id="root"></div>
+  </body>
+</html>