Skip to content

An accessibility reporting tool used to track the status of youtube captioning status.

Notifications You must be signed in to change notification settings

sul-dlss-labs/alor

Repository files navigation

ALOR

Why Alor?

This started as "Accessibility Review Dashboard", or ARD, which is the airport code for Alor Island Airport.

This project does not currently include the framework for a dashboard interface but could be added in the future.

Installation & Setup

Clone the repository

git clone https://github.com/sul-dlss-labs/alor.git

Setup your local credentials

Create a local settings file for your auth key

Create a settings.local.yml file in the config path and add the following content:

youtube:
  api_key: '[YOUR API KEY]'

You can acquire an API key by visiting Google API Credentials

Optionally you can add a default channel ID to your local config under youtube in settings.local.yml add:

channel_id: 'CHANNEL_ID'

Note: If a default channel ID is not set, you will need to pass the ID to the rake task.

Run the caption report through rake

With a default channel id set:

bundle exec rake youtube:caption_report

Without a default channel id set:

bundle exec rake youtube:caption_report["CHANNEL_ID"]

The exported CSV file will be available in storage/reports/<CHANNEL_ID>-<DATETIME>.csv

About

An accessibility reporting tool used to track the status of youtube captioning status.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published