squirrels 0.1.1.post1__py3-none-any.whl → 0.2.0.dev0__py3-none-any.whl

squirrels/package_data/base_project/pyconfigs/context.py

@@ -0,0 +1,45 @@
+from typing import Any
+import squirrels as sr
+
+
+def main(ctx: dict[str, Any], sqrl: sr.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.
+
+    Note that the code here is used by all datasets, regardless of the parameters they use. You can use 
+    sqrl.prms and sqrl.args to determine the conditions to execute certain blocks of code.
+    """
+
+    if "group_by" in sqrl.prms:
+        group_by_param: sr.SingleSelectParameter = sqrl.prms["group_by"]
+        ctx["group_by_cols_list"]: list[str] = group_by_param.get_selected("columns")
+        ctx["group_by_cols"] = ",".join(ctx["group_by_cols_list"])
+        ctx["order_by_cols"] = ",".join((x+" DESC") for x in ctx["group_by_cols_list"])
+
+    if "start_date" in sqrl.prms:
+        start_date_param: sr.DateParameter = sqrl.prms["start_date"]
+        ctx["start_date"] = start_date_param.get_selected_date_quoted()
+    
+    if "end_date" in sqrl.prms:
+        end_date_param: sr.DateParameter = sqrl.prms["end_date"]
+        ctx["end_date"] = end_date_param.get_selected_date_quoted()
+    
+    if "category" in sqrl.prms:
+        category_param: sr.MultiSelectParameter = sqrl.prms["category"]
+        ctx["has_categories"] = category_param.has_non_empty_selection()
+        ctx["categories"] = category_param.get_selected_labels_quoted_joined()
+    
+    if "subcategory" in sqrl.prms:
+        subcategory_param: sr.MultiSelectParameter = sqrl.prms["subcategory"]
+        ctx["has_subcategories"] = subcategory_param.has_non_empty_selection()
+        ctx["subcategories"] = subcategory_param.get_selected_labels_quoted_joined()
+    
+    if "min_filter" in sqrl.prms:
+        min_amount_filter: sr.NumberParameter = sqrl.prms["min_filter"]
+        ctx["min_amount"] = min_amount_filter.get_selected_value()
+    
+    if "max_filter" in sqrl.prms:
+        max_amount_filter: sr.NumberParameter = sqrl.prms["max_filter"]
+        ctx["max_amount"] = max_amount_filter.get_selected_value()
+    

squirrels/package_data/base_project/pyconfigs/parameters.py

@@ -0,0 +1,55 @@
+import squirrels as sr
+
+
+def main(sqrl: sr.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:
+    > sr.SingleSelectParameter.Create(...)
+
+    The parameter classes available are:
+    - SingleSelectParameter, MultiSelectParameter, DateParameter, DateRangeParameter, NumberParameter, NumberRangeParameter
+    
+    The factory methods available are:
+    - Create, CreateSimple, CreateFromSource
+    """
+
+    """ Example of creating SingleSelectParameter and specifying each option by code """
+    group_by_options = [
+        sr.SelectParameterOption("g0", "Transaction", columns=["ID", "Date"]),
+        sr.SelectParameterOption("g1", "Date", columns=["Date"]),
+        sr.SelectParameterOption("g2", "Category", columns=["Category"]),
+        sr.SelectParameterOption("g3", "Subcategory", columns=["Category", "Subcategory"]),
+    ]
+    sr.SingleSelectParameter.Create("group_by", "Group By", group_by_options)
+
+    """ Example of creating DateParameter """
+    sr.DateParameter.CreateSimple("start_date", "Start Date", "2023-01-01")
+
+    """ Example of creating DateParameter from list of DateParameterOption's """
+    end_date_option = [sr.DateParameterOption("2023-12-31")]
+    sr.DateParameter.Create("end_date", "End Date", end_date_option)
+
+    """ Example of creating DateRangeParameter """
+    sr.DateRangeParameter.CreateSimple("date_range", "Date Range", "2023-01-01", "2023-12-31")
+
+    """ Example of creating MultiSelectParameter from lookup query/table """
+    category_ds = sr.MultiSelectDataSource("categories", "Category_ID", "Category")
+    sr.MultiSelectParameter.CreateFromSource("category", "Category Filter", category_ds)
+
+    """ Example of creating MultiSelectParameter with parent from lookup query/table """
+    subcategory_ds = sr.MultiSelectDataSource("subcategories", "Subcategory_ID", "Subcategory", parent_id_col="Category_ID")
+    sr.MultiSelectParameter.CreateFromSource("subcategory", "Subcategory Filter", subcategory_ds, parent_name="category")
+
+    """ Example of creating NumberParameter """
+    sr.NumberParameter.CreateSimple("min_filter", "Amounts Greater Than", min_value=0, max_value=500, increment=10)
+    
+    """ 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 = sr.NumberDataSource(query, "min_value", "max_value", increment_col="increment", default_value_col="max_value")
+    sr.NumberParameter.CreateFromSource("max_filter", "Amounts Less Than", max_amount_ds)
+
+    """ Example of creating NumberRangeParameter """
+    sr.NumberRangeParameter.CreateSimple("between_filter", "Amounts Between", 0, 500, default_lower_value=10, default_upper_value=400)

squirrels/package_data/base_project/seeds/mocks/category.csv

@@ -0,0 +1,3 @@
+Category_ID,Category
+0,Food
+1,Bills

squirrels/package_data/base_project/seeds/mocks/max_filter.csv

@@ -0,0 +1,2 @@
+min_value,max_value,increment
+0,500,10

squirrels/package_data/base_project/seeds/mocks/subcategory.csv

@@ -0,0 +1,6 @@
+Subcategory_ID,Subcategory,Category_ID
+0,Dining Out,0
+1,Groceries,0
+2,Utilities,1
+3,Mobile,1
+4,Internet,1

squirrels/package_data/base_project/squirrels.yml.j2

@@ -0,0 +1,57 @@
+project_variables:
+  name: sample
+  label: Sample Product
+  major_version: 1
+  minor_version: 0
+
+
+packages: []
+
+## Example value for packages:
+#  - git: https://.../myrepo.git
+#    revision: v0.1.0
+#    directory: custom_name ## optional
+
+
+{{ connections -}}
+
+
+{{ parameters -}}
+
+
+selection_test_sets:
+  - name: sample_test_set
+    user_attributes:     ## optional unless there are user attributes used by parameters or models
+      organization: org1
+    parameters:          ## optional - for unspecified parameters, default value is used
+      group_by: g3
+      start_date: 2023-02-01
+      end_date: 2023-12-01
+      category: ["1"]
+
+
+datasets:
+  - name: dataset_example  ## model with same name is used unless "model" field is specified for dataset
+    label: Dataset Example
+    scope: public          ## optional - one of 'public' (default), 'protected', or 'private'
+    parameters:            ## optional - if not specified, then all parameters are used
+      - group_by
+      - start_date
+      - end_date
+      - category
+      - subcategory
+      - min_filter
+      - max_filter
+    args: {} ## optional
+
+
+settings: {}
+
+## Default values for settings:
+#   auth.token.expire.minutes: 30
+#   parameters.cache.size: 1024
+#   parameters.cache.ttl.minutes: 0
+#   results.cache.size: 128
+#   results.cache.ttl.minutes: 0
+#   defaults.dbviews.connection_name: default
+#   defaults.federates.materialized: table

squirrels/package_data/base_project/tmp/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

squirrels/package_data/static/script.js

@@ -1,3 +1,4 @@
+const projectSelect = document.getElementById('project-select');
 const datasetSelect = document.getElementById('dataset-select');
 const generatedParamsDiv = document.getElementById('generated-parameters');
 
@@ -8,33 +9,93 @@ const tableBody = document.getElementById('table-body');
 
 const loadingIndicator = document.getElementById('loading-indicator');
 
+const loginModal = document.getElementById('login-modal');
+const loginForm = document.getElementById('login-form');
+const incorrectPwdMessage = document.getElementById('incorrectpwd');
+let loginProcessor = null;
+
+const usernameTxt = document.getElementById('username-txt');
+
 const datasetsMap = new Map();
 const parametersMap = new Map();
 
-function callJsonAPI(path, func) {
+async function loginEvent(event) {
+    event.preventDefault();
+    const formData = new FormData(loginForm);
+    const response = await fetch(token_path, {
+        method: 'POST',
+        body: formData
+    })
+
+    if (response.status === 401) {
+        incorrectPwdMessage.style.display = 'block'
+    } 
+    else {
+        const data = await response.json();
+        sessionStorage.setItem("jwt_token", data.access_token);
+        sessionStorage.setItem("username", `"${data.username}"`);
+        callJsonAPI(catalog_path, renderDatasetsSelection);
+        updateUsername();
+        closeLoginModal();
+    }
+}
+
+async function updateUsername() {
+    const username = sessionStorage.getItem("username");
+    usernameTxt.innerHTML = (username === null) ? "guest" : username;
+}
+
+async function openLoginModal() {
+    loginModal.style.display = 'flex';
+    loadingIndicator.style.display = 'none';
+}
+
+async function closeLoginModal() {
+    loginForm.reset()
+    loginModal.style.display = 'none';
+    incorrectPwdMessage.style.display = 'none';
+}
+
+async function callJsonAPI(path, func) {
     loadingIndicator.style.display = 'flex';
-    fetch(path)
-        .then(response => response.json())
-        .then(data => {
-            func(data);
-        })
-        .catch(error => {
-            alert('Server error...')
-            console.log(error)
-        })
-        .then(_ => {
-            loadingIndicator.style.display = 'none'
-        })
+    const jwt_token = sessionStorage.getItem("jwt_token");
+    const response = await fetch(path, {
+        headers: {
+            'Authorization': `Bearer ${jwt_token}`
+        }
+    });
+
+    if (response.status === 401) {
+        alert("Unauthorized action. Please try to 'Authorize' first");
+    } 
+    else if (response.status === 200) {
+        const data = await response.json();
+        func(data);
+    } 
+    else {
+        const error = `Unexpected response status: ${response.status}`;
+        alert(error);
+    }
+    loadingIndicator.style.display = 'none';
 }
 
-function changeDatasetSelection() {
+async function changeDatasetSelection() {
     tableContainers.style.display = 'none';
     parametersMap.clear()
     refreshParameters();
 }
 
-function renderDatasetsSelection(data) {
-    const datasets = data.products[0].versions[0].datasets
+async function renderDatasetsSelection(data) {
+    projectSelect.innerHTML = "";
+    datasetSelect.innerHTML = "";
+
+    const product = data.products[0];
+    const option = document.createElement('option');
+    option.value = product.name;
+    option.textContent = product.label;
+    projectSelect.appendChild(option);
+
+    const datasets = product.versions[0].datasets;
     datasets.forEach(resource => {
         const option = document.createElement('option');
         option.value = resource.name;
@@ -42,18 +103,23 @@ function renderDatasetsSelection(data) {
         datasetSelect.appendChild(option);
         datasetsMap.set(option.value, resource);
     });
-    changeDatasetSelection();
+    
+    if (datasets.length === 0) {
+        alert("No datasets available! Authentication may be required to access.");
+    } 
+    else {
+        changeDatasetSelection();
+    }
 }
 
-function refreshParameters(provoker = null) {
+async function refreshParameters(provoker = null) {
     const selectedDatasetValue = datasetSelect.value;
     const parametersPath = datasetsMap.get(selectedDatasetValue).parameters_path;
-    const queryParameters = getQueryParams(provoker)
+    const queryParameters = await getQueryParams(provoker)
     const parametersRequest = parametersPath + '?' + queryParameters
-    console.log('Parameters request:', parametersRequest)
 
     callJsonAPI(parametersRequest, (jsonResponse) => {
-        jsonResponse.parameters.forEach(function(param) {
+        jsonResponse.parameters.forEach(param => {
             parametersMap.set(param.name, param);
         })
         generatedParamsDiv.innerHTML = "";
@@ -66,7 +132,7 @@ function refreshParameters(provoker = null) {
                 newDiv.appendChild(paramLabel)
             }
 
-            if (param.widget_type === "DateParameter") {
+            if (param.widget_type === "date") {
                 addLabel()
                 const dateInput = document.createElement('input')
                 dateInput.type = 'date'
@@ -74,7 +140,12 @@ function refreshParameters(provoker = null) {
                 dateInput.value = param.selected_date
                 dateInput.onchange = updateParameter
                 newDiv.appendChild(dateInput)
-            } else if (param.widget_type === "NumberParameter") {
+            } 
+            else if (param.widget_type === "date_range") {
+                // TODO
+                addLabel()
+            } 
+            else if (param.widget_type === "number") {
                 addLabel()
                 const sliderInput = document.createElement('input')
                 sliderInput.type = 'range'
@@ -96,13 +167,16 @@ function refreshParameters(provoker = null) {
 
                 newDiv.appendChild(sliderInput)
                 newDiv.appendChild(sliderValue)
-            } else if (param.widget_type === "NumRangeParameter") {
+            } 
+            else if (param.widget_type === "number_range") {
                 // TODO
-            } else if (param.widget_type === "SingleSelectParameter" && param.options.length > 0) {
+                addLabel()
+            } 
+            else if (param.widget_type === "single_select" && param.options.length > 0) {
                 addLabel()
                 const singleSelect = document.createElement('select');
                 singleSelect.id = param.name;
-                param.options.forEach(function(option) {
+                param.options.forEach(option => {
                     const selectOption = document.createElement('option');
                     selectOption.value = option.id;
                     if (option.id === param.selected_id) {
@@ -113,12 +187,13 @@ function refreshParameters(provoker = null) {
                 });
                 singleSelect.onchange = updateParameter
                 newDiv.appendChild(singleSelect);
-            } else if (param.widget_type === "MultiSelectParameter" && param.options.length > 0) {
+            } 
+            else if (param.widget_type === "multi_select" && param.options.length > 0) {
                 addLabel()
                 const multiSelect = document.createElement('select');
                 multiSelect.id = param.name;
                 multiSelect.multiple = true;
-                param.options.forEach(function(option) {
+                param.options.forEach(option => {
                     const selectOption = document.createElement('option');
                     selectOption.value = option.id;
                     if (param.selected_ids.includes(option.id)) {
@@ -135,17 +210,24 @@ function refreshParameters(provoker = null) {
     });
 }
 
-function updateParameter() {
+async function updateParameter() {
     const param = parametersMap.get(this.id)
-    if (param.widget_type === "DateParameter") {
+    if (param.widget_type === "date") {
         param.selected_date = this.value
-    } else if (param.widget_type === "NumberParameter") {
+    } 
+    else if (param.widget_type === "date_range") {
+        // TODO
+    } 
+    else if (param.widget_type === "number") {
         param.selected_value = this.value
-    } else if (param.widget_type === "NumRangeParameter") {
+    } 
+    else if (param.widget_type === "number_range") {
         // TODO
-    } else if (param.widget_type === "SingleSelectParameter") {
+    } 
+    else if (param.widget_type === "single_select") {
         param.selected_id = this.options[this.selectedIndex].value
-    } else if (param.widget_type === "MultiSelectParameter") {
+    } 
+    else if (param.widget_type === "multi_select") {
         param.selected_ids = [...this.selectedOptions].map(option => option.value)
     }
     
@@ -154,19 +236,26 @@ function updateParameter() {
     }
 }
 
-function getQueryParams(provoker = null) {
+async function getQueryParams(provoker = null) {
     const queryParams = {}
-    function addToQueryParams(key, value) {
-        if (value.widget_type === "DateParameter") {
-            queryParams[key] = value.selected_date
-        } else if (value.widget_type === "NumberParameter") {
-            queryParams[key] = value.selected_value
-        } else if (value.widget_type === "NumRangeParameter") {
-            // TODO
-        } else if (value.widget_type === "SingleSelectParameter") {
-            queryParams[key] = value.selected_id
-        } else if (value.widget_type === "MultiSelectParameter") {
-            result = JSON.stringify(value.selected_ids)
+    function addToQueryParams(key, param) {
+        if (param.widget_type === "date") {
+            queryParams[key] = param.selected_date
+        } 
+        else if (param.widget_type === "date_range") {
+            queryParams[key] = param.selected_start_date + ',' + param.selected_end_date
+        } 
+        else if (param.widget_type === "number") {
+            queryParams[key] = param.selected_value
+        } 
+        else if (param.widget_type === "number_range") {
+            queryParams[key] = param.selected_lower_value + ',' + param.selected_upper_value
+        } 
+        else if (param.widget_type === "single_select") {
+            queryParams[key] = param.selected_id
+        } 
+        else if (param.widget_type === "multi_select") {
+            const result = JSON.stringify(param.selected_ids)
             if (result !== '') queryParams[key] = result
         }
     }
@@ -174,19 +263,18 @@ function getQueryParams(provoker = null) {
         addToQueryParams(provoker.name, provoker)
     }
     else {
-        for (const [key, value] of parametersMap.entries()) {
-            addToQueryParams(key, value)
+        for (const [key, param] of parametersMap.entries()) {
+            addToQueryParams(key, param)
         }
     }
-    console.log(queryParams)
     return new URLSearchParams(queryParams)
 }
 
-function getDatasetResults() {
+async function getDatasetResults() {
     const selectedDatasetValue = datasetSelect.value;
     const resultPath = datasetsMap.get(selectedDatasetValue).result_path;
-    const resultRequest = resultPath + '?' + getQueryParams()
-    console.log('Result request:', resultRequest)
+    const queryParams = await getQueryParams();
+    const resultRequest = resultPath + '?' + queryParams
 
     callJsonAPI(resultRequest, (jsonResponse) => {
         tableHeader.innerHTML = ''
@@ -216,19 +304,27 @@ function getDatasetResults() {
     });
 }
 
-function copyTable() {
+async function copyTable() {
     let text = "";
 
     for (let i = 0; i < resultTable.rows.length; i++) {
-      for (let j = 0; j < resultTable.rows[i].cells.length; j++) {
-        text += resultTable.rows[i].cells[j].innerHTML + "\t";
-      }
-      text += "\n";
+        for (let j = 0; j < resultTable.rows[i].cells.length; j++) {
+            text += resultTable.rows[i].cells[j].innerHTML + "\t";
+        }
+        text += "\n";
     }
 
-    navigator.clipboard.writeText(text).then(function() {
-      alert("Table copied to clipboard!");
-    }, function() {
-      alert("Copying failed.");
-    });
-}
+    navigator.clipboard.writeText(text).then(
+        () => {
+            alert("Table copied to clipboard!");
+        }, 
+        () => {
+            alert("Copying failed.");
+        }
+    );
+}
+
+
+loginForm.addEventListener('submit', loginEvent);
+loginForm.addEventListener('reset', closeLoginModal);
+updateUsername();

squirrels/package_data/static/style.css

@@ -1,3 +1,4 @@
+/* Generic styling */
 table {
     border-collapse: collapse;
     width: 100%;
@@ -34,44 +35,85 @@ input[type="range"] {
 }
 
 input[type=submit] {
+    padding: 12px 20px;
+    cursor: pointer;
+}
+
+button {
+    cursor: pointer;
+    border-radius: 5px;
+    padding: 10px;
+}
+
+.white-button {
+    background-color: white;
+    color: blue;
+}
+
+.white-button:hover {
+    background-color: #d4dae1;
+}
+
+.blue-button {
     background-color: #4285f4;
     color: white;
-    padding: 12px 20px;
     border: none;
-    border-radius: 4px;
-    cursor: pointer;
 }
 
-input[type=submit]:hover {
+.blue-button:hover {
     background-color: #3076c5;
 }
 
-#main-container {
+.horizontal-container {
     display: flex;
 }
 
+.slider-value {
+    display: inline-block;
+    position: relative;
+    left: 10px;
+    bottom: 14px;
+    font-size: 18px;
+}
+
+/* Specific styling */
+#main-container {
+    height: 97vh;
+    width: 99vw;
+}
+
 #parameter-container {
     width: 250px;
     min-width: 250px;
-    margin-right: 50px;
+    margin-right: 20px;
+    padding: 10px;
+    overflow-y: auto;
+}
+
+#right-container {
+    height: 97vh;
+    width: calc(99vw - 300px);
+}
+
+#header-container {
+    background-color: #d4dae1;
+    color: black;
+    display: flex;
+    align-items: center;
+    justify-content: space-between;
     padding: 10px;
 }
 
 #table-container {
     display: none;
     padding: 10px 20px;
+    height: calc(97vh - 70px);
+    overflow-x: auto;
+    overflow-y: auto;
 }
 
 #result-table {
-    margin: 20px 0px;
-}
-
-.slider-value {
-    display: inline-block;
-    position: relative;
-    left: 10px;
-    bottom: 14px;
-    font-size: 18px;
+    margin: 5px 0px;
 }
 
 /* Loading section */
@@ -108,3 +150,25 @@ input[type=submit]:hover {
         transform: rotate(360deg);
     }
 }
+
+/* The Modal */
+.modal-background {
+    display: none;
+    position: fixed;
+    z-index: 1;
+    left: 0;
+    top: 0;
+    width: 100%;
+    height: 100%;
+    overflow: auto;
+    background-color: rgba(0,0,0,0.4);
+    padding-top: 60px;
+}
+
+.modal-content {
+    background-color: #fefefe;
+    padding: 16px;
+    margin: 5px auto auto auto;
+    border: 1px solid #888;
+    width: 40%;
+}