search

SuffolkLITLab / docassemble-InterviewStats

A docassemble extension.
MIT License
1 stars 0 forks source link
document-assembly-line

readme

docassemble.InterviewStats

PyPI version

A docassemble interview that lets you view statistics from other saved interview responses.

Getting Started

  1. Pull this package into your docassemble playground, or install it on your docassemble server.
  2. To generate data that this interview can consume, use the store_variables_snapshot() function in your interview, i.e. store_variables_snapshot(data={'zip': users[0].address.zip}).
  3. Once you have reached the store_variables_snapshot point in your target interview, start the stats interview.
    1. If you're in the playground, run the stats.yml interview.
    2. If you installed the package, go to the /start/InterviewStats/stats/ URL to start the interview.
  4. Select the target interview in the drop down.
  5. You can export the data in a Excel format by clicking the Download link on the stats page.

Anonymous stats

If you would like to provide login-less access to stats for an interview in your dispatch directive, you can do so as follows:

  1. Add a directive in your configuration file, like this: 
    stats subscriptions:
- cdc_moratorium: 12345abcedfg17821309
- 209a: 4859123jkljsafdsf0913132

Where the value on the left corresponds to the key of an entry in your dispatch directive, and the value on the right is an arbitrary password you create. I recommend using something like https://onlinehashtools.com/generate-random-md5-hash to create a random password to control access.

You can add as many unique passwords as you want for each entry you share. This means you can distribute multiple links without sharing the password.

Then, someone can access the link to a specific interview's stats by visiting this url:

/start/InterviewStats/subscribe/?link=cdc_moratorium&auth=12345abcedfg17821309

They will be directed immediately to download an XlSX file containing the statistics.

Example

Example Pic

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.

If you have specific feature requests, feel free to open an issue or make a PR!

Authors