Skip to content

Latest commit

 

History

History

fine-arts-jr-review

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Fine Arts Junior Review

These scripts help with Fine Arts Junior Review in VAULT. They perform two actions:

  • populate a "Fine Arts Junior Review students" taxonomy
  • populate two permissions groups in VAULT, "FA JR film and animation students" and "FA JR exhibit students" (for all other FA programs)

The taxonomy data is used in the FAJR contribution wizard to autofill fields like "student ID" so students don't have to. The permissions groups are used in a few ways, including showing these students the FAJR collection on the Contribute page, filtering students to the appropriate contribution wizard page (ANIMA/FILMS vs others), and then making other students' FAJR items visible when typically students cannot see each others' works.

Setup

Uses poetry for virtual environment and dependency management.

> poetry install # install dependencies
> poetry shell # enter virtual env

Analogous to pipenv, we can prefix commands with poetry run rather than entering the venv.

Execution

  • obtain a CSV1 & name it fajr.csv
  • poetry run fajr fajr.csv
  • this adds usernames to the two permissions groups & generates a taxonomy CSV named "taxo.csv", then runs upload.sh to upload the taxonomy to EQUELLA
  • afterwards the upload script offers to archive fajr.csv & taxo.csv in a "data" directory

The "fajr/process.py" script relies on a configured ".equellarc" file (see equella-cli for details on that) with a configured OAuth token in your user's home directory. The upload.sh script relies on 1Password CLI, a 1Password login named "VAULT ($YOUR_USERNAME)", and the (included) uptaxo abstraction over EQUELLA's command-line tools for updating taxonomies. Note that, while this project is Python 3, uptaxo and its dependencies (equellasoap.py, util.py) are old code from EQUELLA and require a python2 binary on your path.

Footnotes

  1. Formerly this CSV was downloaded from an Informer report, now we create it from data provided by the Fine Arts office. In the future, we may use a Workday Report. The CSV must contain id,name,major,username as column headers.