docassemble.InterviewStats 0.5.3__tar.gz → 0.6.0__tar.gz

{docassemble_interviewstats-0.5.3/docassemble.InterviewStats.egg-info → docassemble_interviewstats-0.6.0}/PKG-INFO

@@ -1,15 +1,12 @@
 Metadata-Version: 2.4
 Name: docassemble.InterviewStats
-Version: 0.5.3
+Version: 0.6.0
 Summary: A docassemble interview to view statistics from other saved interview responses.
 Author-email: Suffolk Legal Innovation and Technology Lab <litlab@suffolk.edu>
 License-Expression: MIT
 Project-URL: GitHub, https://github.com/SuffolkLITLab/docassemble-InterviewStats
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: bokeh>=2.4.2
-Requires-Dist: cenpy>=1.0.0.post4
-Requires-Dist: geopandas>=0.9.0
 Requires-Dist: numpy>=1.0.4
 Requires-Dist: pandas>=1.4.2
 Requires-Dist: requests>=2.27.1
@@ -59,20 +56,10 @@ visiting this url:
 They will be directed immediately to download an XlSX file containing the
 statistics.
 
-## Example
-
-![Example Pic](static/example_pic.png)
-
-
-## Roadmap
-
-Currently, we can show simple grouping over all the data points in the interview stats. However, the
-special visualization are only shown on based on the `zip` attribute. We're working to expand the
-features available here in conjunction with our [EFiling Integration](https://github.com/SuffolkLITLab/EfileProxyServer).
+## Contributing 
 
 If you have specific feature requests, feel free to open an issue or make a PR!
 
-
 ## Authors
 
 * Quinten Steenhuis

{docassemble_interviewstats-0.5.3 → docassemble_interviewstats-0.6.0}/README.md

@@ -42,20 +42,10 @@ visiting this url:
 They will be directed immediately to download an XlSX file containing the
 statistics.
 
-## Example
-
-![Example Pic](static/example_pic.png)
-
-
-## Roadmap
-
-Currently, we can show simple grouping over all the data points in the interview stats. However, the
-special visualization are only shown on based on the `zip` attribute. We're working to expand the
-features available here in conjunction with our [EFiling Integration](https://github.com/SuffolkLITLab/EfileProxyServer).
+## Contributing 
 
 If you have specific feature requests, feel free to open an issue or make a PR!
 
-
 ## Authors
 
 * Quinten Steenhuis

docassemble_interviewstats-0.6.0/docassemble/InterviewStats/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.6.0"

{docassemble_interviewstats-0.5.3 → docassemble_interviewstats-0.6.0}/docassemble/InterviewStats/data/questions/data_report.yml

@@ -37,6 +37,7 @@ code: |
 #	Question screens
 #--------------------------------------------------------------------------
 ---
+id: data-reporting
 question: |
   Data Reporting
 subquestion: |
@@ -55,6 +56,7 @@ fields:
     code: |      
       [{interview.get('filename'): interview.get('title')} for interview in interview_menu()] or get_filenames()
 ---
+id: quick-summary-screen
 question: |
   Quick Summary for ${ interview_title }
 subquestion: |
@@ -65,10 +67,8 @@ subquestion: |
   % if summary_stats[0] > 10000:
   You have a lot of sessions; some operations might take a long time.
   % endif  
-  ---
-  Do you want to filter your data records by date?
 fields:      
-  - no label: filter_date
+  - Do you want to filter your data records by date?: filter_date
     datatype: yesnoradio
     default: False
     required: False
@@ -117,15 +117,17 @@ subquestion: |
   The following fields are from single-valued questions, except those whose answer lack statistic value, such as user-typed answer or numeric input. 
   
   Select a field to see its table:<br>
-    % for col in col_headings_single:  
-      [${col}](${ url_action('show_filtered_data_single', filter_by = col)  })
+    % for col_single in col_headings_single:  
+      [${col_single}](${ url_action('show_filtered_data_single', filter_by = col_single)  })
     % endfor
   % endif
   
   #### All questions (excluding text/area/number fields)
-  [Click here](${ url_action('display_filtered_data_all')  }) to see all the question tables on one screen.
+
+  Click this link to see [all the question tables on one screen](${ url_action('display_filtered_data_all')  }).
 
   #### Download an excel file:
+
   To extract complete data including text/area/numeric fields, make an excel file:<br>
   [:file-excel: Make Excel Download](${ url_ask('generate_excel') })
 ---
@@ -201,6 +203,7 @@ code: |
       no_reportable_data
 ---
 event: no_interview_stats
+id: interview-has-no-data
 question: Interview has no data!
 subquestion: |  
   The interview you selected is <br>
@@ -211,6 +214,7 @@ buttons:
   - Restart: restart
 ---
 event: no_reportable_data
+id: interview-has-no-reportable-data
 question: Interview has no reportable data, you should use Stats
 subquestion: | 
   The interview you selected is <br>
@@ -244,6 +248,7 @@ code: |
     no_filtered_stats
 ---
 event: no_filtered_stats
+id: no-records-in-this-period
 question: No records in this period
 subquestion: |
   % if date_op == 'between':
@@ -359,6 +364,7 @@ code: |
     show_excel_download
 ---
 event: show_excel_download
+id: show-excel-download
 question: |
   Excel Download
 subquestion: |
@@ -390,6 +396,7 @@ subquestion: |
 reload: True
 ---
 event: show_failed_screen
+id: failed-screen
 question: |
   Sorry, something went wrong
 subquestion: |

{docassemble_interviewstats-0.5.3 → docassemble_interviewstats-0.6.0}/docassemble/InterviewStats/data/questions/stats.yml

@@ -22,7 +22,6 @@ default screen parts:
 ---
 modules:
   - .snapshot_statistics
-  # - .snapshot_geography
 ---
 objects:
   - xlsx_output: DAFile.using(filename="stats.xlsx")
@@ -64,6 +63,7 @@ code: |
     generate_excel = True
 ---
 event: show_excel_download
+id: show-excel-download
 question: |
   Excel Download
 subquestion: |
@@ -125,6 +125,7 @@ subquestion: |
 reload: True
 ---
 event: show_failed_screen
+id: failed-screen
 question: |
   Sorry, something went wrong
 subquestion: |
@@ -140,9 +141,10 @@ code: |
   background_response()
 ---
 code: |
-  summary_stats = get_summary_stats(filename)
+  summary_stats = get_summary_stats(filename, date_from=stats_date_from if filter_by_date else None, date_to=stats_date_to if filter_by_date else None)
 ---
 reconsider: summary_stats
+id: summary-data-screen
 question: |
   Summary data for ${ interview_title }
 subquestion: |
@@ -155,11 +157,6 @@ subquestion: |
   take a long time.
   % endif
 continue button field: simple_data
-# ---
-# code: |
-#   geo_layout = make_usage_map(formatted_data)
-#   map_script, map_div, map_inline = get_embedable_usage_map(geo_layout)
-#   del geo_layout
 ---
 # question: Interview Statistics 
 # subquestion: |      
@@ -179,9 +176,9 @@ continue button field: simple_data
 code: |
   overall_stats = get_overall_stats()
   summary_by_filename = get_summary_stats_by_filename()
-  session_overall_stats = get_session_overall_stats()
   session_summary_by_filename = get_session_summary_stats_by_filename()
 ---
+id: what-interview-do-you-want-to-view-statistics-for
 question: |
   What interview do you want to view statistics for?
 under: |
@@ -199,20 +196,8 @@ under: |
   on your server and interviews.
 
   Total sessions with saved statistics across all interviews: ${ overall_stats[0] }
-  
-  <div class="stats-tabs">
-    <ul class="nav nav-tabs" id="stats-tabs">
-      <li class="nav-item">
-        <a href="#" class="nav-link active" id="snapshots-tab">Snapshots</a>
-      </li>
-      <li class="nav-item">
-        <a href="#" class="nav-link" id="sessions-tab">All sessions</a>
-      </li>
-    </ul>
-  </div>
 
   % if summary_by_filename:
-  <div id="snapshots-panel">
   <div style="margin-bottom:0.5rem">
     <a href="${ url_ask('generate_summary_excel') }" class="btn btn-link">
       <i class="fa fa-file-excel" aria-hidden="true"></i>
@@ -246,19 +231,39 @@ under: |
     % endfor
     </tbody>
   </table>
-  </div>
-
-  
   % endif
+
+  <p><a href="${ url_ask('session_data_screen') }">View all sessions by interview title</a></p>
+fields:
+  - Filename: filename
+    datatype: combobox
+    code: |
+      get_combined_filename_list()
+  - Filter by date range?: filter_by_date
+    datatype: yesno
+    default: False
+  - From date: stats_date_from
+    datatype: date
+    show if: filter_by_date
+  - To date: stats_date_to
+    datatype: date
+    show if: filter_by_date
+---
+code: |
+  session_summary_by_filename = get_session_summary_stats_by_filename()
+---
+event: session_data_screen
+id: session-data-screen
+question: |
+  All sessions by interview title
+subquestion: |
   % if session_summary_by_filename:
-  <div id="sessions-panel" style="display:none;">
   <div style="margin-bottom:0.5rem">
     <a href="${ url_ask('generate_sessions_excel') }" class="btn btn-link">
       <i class="fa fa-file-excel" aria-hidden="true"></i>
       Download session summary
     </a>
   </div>
-  <h2 class="h4">All sessions by interview title</h2>
   <table id="sessions-table" class="table table-striped table-bordered sortable">
     <thead>
       <tr>
@@ -277,26 +282,24 @@ under: |
         <td>${ row.get('count_30d', 0) }</td>
         <td>${ row.get('count_90d', 0) }</td>
         <td>${ row.get('count_365d', 0) }</td>
-  <td>${ row.get('count_all', 0) }</td>
-  <td>${ format_date(row.get('max_all'), format='MM/dd/yyyy') if row.get('max_all') else '' }</td>
+        <td>${ row.get('count_all', 0) }</td>
+        <td>${ format_date(row.get('max_all'), format='MM/dd/yyyy') if row.get('max_all') else '' }</td>
       </tr>
     % endfor
     </tbody>
   </table>
-  </div>
+  % else:
+  No session data found.
   % endif
-fields:
-  - Filename: filename
-    datatype: combobox
-    code: |
-      get_combined_filename_list()
+
+  [Back to summary](${ url_ask('filename') })
 ---
 code: |
   if filename is not None:
     if 'data/questions' in filename or 'playground' in filename:
-      stats = get_stats(filename)
+      stats = get_stats(filename, date_from=stats_date_from if filter_by_date else None, date_to=stats_date_to if filter_by_date else None)
     else:
-      stats = get_stats(filename.replace(':',':data/questions/'))
+      stats = get_stats(filename.replace(':',':data/questions/'), date_from=stats_date_from if filter_by_date else None, date_to=stats_date_to if filter_by_date else None)
   else:
     no_interview_stats
 ---
@@ -309,6 +312,7 @@ code: |
   if stats and 'title' in stats[0].keys():
     interview_title = stats[0]['title']
 ---
+id: there-are-no-interviews-to-look-for-data-in
 event: no_interview_stats
 question: There are no interviews to look for data in!
 subquestion: |
@@ -335,116 +339,35 @@ code: |
     formatted_data = pd.DataFrame(stats)
     stats_size = formatted_data.shape[0]
 ---
-# mandatory: True
-id: view_data
-question: |
-  Stats for ${interview_title}
-subquestion: |
-  Total submissions: ${ len(stats) }
-
-  % if len(stats):
-  Group by:
-  % for col in groupable_columns:
-  [${col}](${ url_action('show_grouped_data', group_by = col ) }) |
-  % endfor
-
-  [:file-excel: Make Excel Download](${ url_ask('generate_excel') })
-  % endif
-# under: |
-#   ${ map_div }
-fields:
-  - Filter State: filter_state
-    datatype: yesno
-    disable if:
-      code: |
-        'state' not in formatted_data.columns or not possible_states
-  - Find States that: state_op
-    datatype: dropdown
-    show if: filter_state
-    code: |
-      [{'eq': "equal"},
-       {'ne': "don't equal"}]
-  - this state: state_to_filter
-    datatype: dropdown
-    show if: filter_state
-    code: |
-      possible_states
-  - Filter by Date: filter_date
-    datatype: yesno
-    disable if:
-      code: |
-        'modtime' not in formatted_data.columns
-  - Find submissions that are: date_op
-    datatype: dropdown
-    show if: filter_date
-    code: |
-      [{'gt': 'after'},
-       {'lt': 'before'},
-       {'eq': 'the same day as'}]
-  - this date: date_to_filter
-    datatype: date
-    show if: filter_date
-# script: |
-#     ${ map_script}
-continue button field: start_filter
-continue button label: Filter
-#help: |
-#  ${ formatted_data.to_html() }
-# ---
-# mandatory: True
-# event: viewed_filtered
-# depends on: filt_map_script, filt_map_div
-# need: filt_map_script, filt_map_div
-# id: view_filtered_data
-# question: |
-#   Filtered: ${ filter_description }
-# under: |
-#   ${ filt_map_div }
-# script: |
-#     ${ filt_map_script }
-# back button: True
----
 event: show_grouped_data
 code: |
   my_col = action_argument('group_by')
   force_ask('display_grouped_data')
 ---
+id: stats-for
 question: |
   Stats for ${interview_title}
 subquestion: |
   Total submissions: ${ len(stats) }
 
+  % if len(stats):
   Group by:
   % for col in groupable_columns:
   [${col}](${ url_action('show_grouped_data', group_by = col)  })
   % endfor
 
-  ${ formatted_data.groupby(by=my_col).count().to_html(classes=('table','table-striped')) }
+  <%
+    grouped = formatted_data.groupby(by=my_col).count()
+    grouped = grouped.sort_values(grouped.columns[0], ascending=False)
+    total_groups = len(grouped)
+  %>
+  % if total_groups > 50:
+  Showing the top 50 of ${ total_groups } groups by count. Download the Excel file below for the full breakdown.
+  % endif
+  ${ grouped.head(50).to_html(classes=('table','table-striped')) }
 
   [:file-excel: Download](${ url_ask('generate_excel') })
-# under: |
-#   ${ map_div }
-# script: |
-#   ${ map_script }
+  % else:
+  No records found for this date range. Try a wider range or clear the date filter.
+  % endif
 event: display_grouped_data
-# ---
-# need: start_filter
-# depends on: state_op, state_to_filter
-# code: |
-#   filter_list = []
-#   readable = {'state': 'State', 'modtime': 'Date',
-#               'eq': 'is', 'ne': 'is not', 'lt': '<', 'gt': '>'}
-#   if defined('filter_state') and filter_state:
-#     filter_list.append(('state', state_op, state_to_filter))
-#   if defined('filter_date') and filter_date:
-#     date_to_filter = date_to_filter.replace(tzinfo=None)
-#     filter_list.append(('modtime', date_op, date_to_filter))
-
-#   filter_description = ' and '.join(
-#       ['{} {} {}'.format(readable[elem[0]], readable[elem[1]], elem[2])
-#        for elem in filter_list])
-#   filters = get_filters_from_strings(filter_list)
-#   # filt_geo_layout = make_usage_map(formatted_data, geo_col='zip',
-#   #                                  time_col='modtime', filters=filters)
-#   # filt_map_script, filt_map_div, _ = get_embedable_usage_map(filt_geo_layout)
-#   # del filt_geo_layout

{docassemble_interviewstats-0.5.3 → docassemble_interviewstats-0.6.0}/docassemble/InterviewStats/data/questions/subscribe.yml

@@ -72,6 +72,7 @@ code: |
     formatted_data = pd.DataFrame(stats) 
 ---
 event: no_interview_stats
+id: there-are-no-interviews-to-look-for-data-in
 question: There are no interviews to look for data in!
 subquestion: |
   There aren't any interviews that we can look for data in. There should be at least one interview

{docassemble_interviewstats-0.5.3 → docassemble_interviewstats-0.6.0}/docassemble/InterviewStats/data/questions/test_create_snapshot_data.yml

@@ -20,12 +20,16 @@ code: |
   if what_to_do == 'generate':
     number_of_data_points
     # Edit your data here
-    ma_zips = ['01001', '01002', '02330', '02332', '02771', '027771',
-      '02125', '02122', '02124', '02123', '02115', '02116']
+    ma_zips = list(set([f'{random.randint(75001, 79999):05}' for _ in range(300)])) \
+        + list(set([f'{random.randint(1001,2799):05}' for _ in range(300)]))
+    import datetime
+    datetimes = [datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None) - datetime.timedelta(days=i) for i in range(30)]
     def my_generator():
       for _ in range(number_of_data_points):
         yield {'zip': random.choice(ma_zips), 'state': 'MA'}
-    write_random_user(my_generator())
+    def modtime_generator():
+      return random.choice(datetimes)
+    write_random_user(my_generator(), modtime_generator=modtime_generator)
   elif what_to_do == 'delete':
     which_to_delete
     delete_data_from_interview(which_to_delete)
@@ -36,6 +40,7 @@ code: |
   users[0].name.last = 'Brown'
   users[0].address
 ---
+id: snapshot-generator
 question: |
   Snapshot Generator
 subquestion: |
@@ -49,6 +54,7 @@ fields:
       - Generate: generate
       - Delete: delete
 ---
+id: how-many-data-points-do-you-want-to-generate
 question: |
   How many data points do you want to generate?
 fields:
@@ -58,6 +64,7 @@ fields:
     min: 1
     max: 400000
 ---
+id: what-interview-do-you-want-to-delete-all-statistics-from
 question: |
   What interview do you want to delete all statistics from?
 fields:
@@ -73,6 +80,7 @@ validation code: |
   if which_to_delete_confirm != which_to_delete:
     validation_error("Are you sure you are deleting the right one?")
 ---
+id: snapshot-ending-screen
 event: ending_screen
 question: |
   % if what_to_do == 'generate':

{docassemble_interviewstats-0.5.3 → docassemble_interviewstats-0.6.0}/docassemble/InterviewStats/data/questions/test_survey_data_generator.yml

@@ -29,6 +29,7 @@ code: |
 #	Question screens
 #--------------------------------------------------------------------------
 ---
+id: survey data generator
 question: |
   Survey Data Generator
 subquestion: |
@@ -42,6 +43,7 @@ fields:
       - Generate: generate
       - Delete: delete
 ---
+id: how-many-data-points-do-you-want-to-generate
 question: |
   How many data points do you want to generate?
 fields:
@@ -52,6 +54,7 @@ fields:
     min: 1
     max: 4000
 ---
+id: which-survey-interviews-do-you-want-to-delete?
 question: |
   Which survey interviews do you want to delete?
 fields:
@@ -67,6 +70,7 @@ validation code: |
   if which_to_delete_confirm != which_to_delete:
     validation_error("Are you sure you are deleting the right one?")
 ---
+id: ending-screen
 event: ending_screen
 question: |
   % if what_to_do == 'generate':

{docassemble_interviewstats-0.5.3 → docassemble_interviewstats-0.6.0}/docassemble/InterviewStats/data/static/sortable.js

@@ -49,38 +49,8 @@
     });
   }
 
-
-  function setupTabs(){
-    var snapTab = document.getElementById('snapshots-tab');
-    var sessTab = document.getElementById('sessions-tab');
-    var snapPanel = document.getElementById('snapshots-panel');
-    var sessPanel = document.getElementById('sessions-panel');
-    if(!snapTab || !sessTab || !snapPanel || !sessPanel) return;
-    if(!snapTab._daTabAttached){
-      snapTab._daTabAttached = true;
-      snapTab.addEventListener('click', function(e){
-        e.preventDefault();
-        snapTab.classList.add('active');
-        sessTab.classList.remove('active');
-        snapPanel.style.display = '';
-        sessPanel.style.display = 'none';
-      });
-    }
-    if(!sessTab._daTabAttached){
-      sessTab._daTabAttached = true;
-      sessTab.addEventListener('click', function(e){
-        e.preventDefault();
-        sessTab.classList.add('active');
-        snapTab.classList.remove('active');
-        sessPanel.style.display = '';
-        snapPanel.style.display = 'none';
-      });
-    }
-  }
-
 $(document).on('daPageLoad', function(){
     var tables = document.querySelectorAll('table.sortable');
     Array.prototype.forEach.call(tables, makeSortable);
-    setupTabs();
 });
-})();
+})();