demarcod1 / librarianz-scripts

A series of tools to automate the Digital Library for the LSJUMB
0 stars 0 forks source link

Librarianz Feature Requests (2) #31

Closed dhing1024 closed 3 years ago

dhing1024 commented 3 years ago

Requesting that the following features be considered for addition:

Restructured Archive Folder

The archive folder currently doesn't hold any content. It will be used for the purpose of housing very old chartz. This will mostly include the LSJUMB repository of paper chartz (about 50 years of old music), although this may house some old typeset chartz as well. Important design aspects are:

Improved Handling of File/Folder Locating

Currently, the Librarianz Scripts utilities parse the Digital Library by checking the directory structure via the folder names. The LSJUMB Digital Music Library Website currently hardcodes a number of Folder IDs into its system. A better way to handle this is to generate a common file, most likely a JSON, that holds the minimal set of Folder IDs (along with the folder's corresponding role in the Drive) needed to function, then using that shared JSON file to inform both the Digital Library web site and the Librarianz Script utility of the directory structure.

The JSON being used in the website would be displayed somewhere in the password-protected area, so that future Librarianz could check to make sure the values are consistent in the event that we need to change drive location. This is certainly a possibility, given that LSJUMB drives are limited to 15 GB and Stanford-owned drives don't appear to have such a limit.

Support for Miscellaneous Items

It is desirable to have a feature that can support Miscellaneous items (e.g. unreleased recordings, fingering chartz, teasers, ARN Licks, arranging resources, parts for unconventional instruments, etc.) that do not fall into the general framework structure of normal chartz. Depending on how much work this would be, it might be better if Librarianz are to manually keep this folder up-to-date, especially since there probably won't be a need to keep shortcuts up-to-date with them.

Clear Broken Shortcuts Utility

In the event that the drive falls into an inconsistent state, one utility that may become useful is a tool that does nothing but clears the drive of any broken shortcuts. This wouldn't be useful in a whole lot of circumstances, but if there are just a few broken shortcuts, this would allow some cleanup without requiring the time commitment needed to run the full remake shortcuts script.

Error Handling Updates

If clean error-handling, as described in #25 hasn't been implemented yet, that should be considered.

demarcod1 commented 3 years ago

Splitting up into multiple individual issues (to be tackled one-by-one in PRs)