avanavana / zotero-esovdb

Gets a specified number of records from the ESOVDB and adds them as items in a Zotero library.

zotero-esovdb

Gets a specified number of records from the ESOVDB (Earth Science Online Video Database), adds them as items in a Zotero library (now publicly available here), and then re-syncs the new Zotero version number or newly assigned Zotero keys with the ESOVDB. Since the public ESOVDB Zotero library has topic and series subcollections for each ESOVDB topic and series, this CLI adds videos retrieved from the ESOVDB to their corresponding subcollections in Zotero, or creates a new subcollection if necessary. Uses avanavana/airtable-api-proxy as a back-end for communicating with both the Airtable and Zotero APIs.

Visit the The Earth Science Online Video Database

Use as CLI

To install as CLI: (in the zotero-esovdb directory) $ npm install -g .. To run: zotvid [ options ] (see below).

Additional Notes

Be sure to create a .env file that contains your own ZOTERO_USER (or use ZOTERO_GROUP if you need to switch between your personal Zotero library and a group library) and ZOTERO_API_KEY values, obtainable through the settings page of your Zotero account, and connect to your own instance of avanavana/airtable-api-proxy.

Usage

Usage: zotvid [ -m <number> ] [ --max-records=<number> ] [ -p <number> ] [ --page-size=<number> ]
              [ -c <number> ] [ --chunk-size=<number>] [ -w <secs>] [ --wait-secs=<secs>]
              [ ( -C <date> | -M <date> ) ] [ ( --created-after=<date> | --modified-after=<date> ) ]
              [ -j ] [ --json ] [ -s ] [ --silent ] [ -v ] [ --version ] [ -h ] [ --help ]

Gets a specified number of records from the ESOVDB (Earth Science Online Video Database), adds them
as items in a Zotero library, and then re-syncs the new Zotero version number or newly assigned
Zotero keys with the ESOVDB.  Uses airtable-api-proxy (https://github.com/avanavana/airtable-api-proxy)
for communicating with both the Airtable and Zotero APIs.

Options:
  -v, --version                Displays the current version of zotvid.
  -m, --max-records <number>   Total number of items to add to Zotero. (default: all items)
  -p, --page-size <number>     Maximum number of items (≤100) to retrieve from ESOVDB for each
                               individual page request. (default: 100)
  -c, --chunk-size <number>    Maxmimum number of items (≤50) to add to Zotero in a single
                               request, to avoid rate-limiting. (default: 50)
  -w, --wait-secs <secs>       Number of seconds to wait between Zotero requests, to avoid
                               rate-limiting. (default: 10)
  -C, --created-after <date>   Include only records created after a specified date. Assumes GMT
                               if time is excluded—if included, zotvid uses the local timezone.
                               Excludes option -M/--modified-after).
  -M, --modified-after <date>  Include only records modified after a specified date. Assumes GMT
                               if time is excluded—if included, zotvid uses the local timezone.
                               Excludes option -C/--created-after).
  -j, --json                   Retrieve raw json without syncing with Zotero.
  -s, --silent                 Run without any logging.
  -h, --help                   Display this help file.

Examples:

  $ zotvid
  Syncs all records in the ESOVDB with Zotero.

  $ zotvid -m 9 -p 3
  Gets the latest 9 records in 3 separate Airtable API calls and syncs them with Zotero.

  $ zotvid -M "2020-12-31 00:00 am"
  Syncs all records modified since Dec 31, 2020 at midnight and syncs them with Zotero.

  $ zotvid -j
  Gets all records in the ESOVDB and downloads them to a json file.

MIT License Copyright (c) 2020-2021 Avana Vana