kshvmdn/crowdmark

A CLI to download all test pages from a Crowdmark page.

crowdmark

A CLI to download all test pages from a Crowdmark page.

Install

Either install via npm or directly via source.

• npm

  $ npm install -g crowdmark

• Source

  $ git clone https://github.com/kshvmdn/crowdmark.git && cd crowdmark && npm install

Usage

• The CLI will take a list of IDs separated by space. Find the page's ID from the URL.

  • https://app.crowdmark.com/score/8fa43520-8fd2-4ad1-9979-40fe05ecf8ab -> 8fa43520-8fd2-4ad1-9979-40fe05ecf8ab

• View the help dialog with --help.

  Usage
    $ crowdmark [--help] [--version] <id, ...> [--show]
  
  Options
    id             Crowdmark page identifier(s) (separate by space) [required].
    -h --help      Display this help dialog.
    -v --version   Display the current version.
    -p --path      Directory where files will be saved (defaults to ~/Desktop/crowdmark-scores).
    -s --show      View the scraping in action.
  
  Example
    $ crowdmark 8fa43520-8fd2-4ad1-9979-40fe05ecf8ab
    $ crowdmark 8fa43520-8fd2-4ad1-9979-40fe05ecf8ab a4893443-e167-4f74-b45c-05b7ae7b6a92

Contribute

This project is completely open source. Feel free to open an issue or submit a pull request. 😄

crowdmark's Issues

Scrape assessment information (mark, notes, etc.)

Find a way to scrape the assessment information (i.e. marks, annotations, etc). I think the best way to serve this information is to save it in a text file along with the screenshots.

Improve file naming

Right now, files are named based on page index, so '0.jpg', '1.jpg', .... Names should be better. Maybe start at 1 instead of 0? Or we should see if it's possible to scrape the test name and prefix each index with that. For example, 'STA247-Test-2_1.jpg', 'STA247-Test-2_2.jpg', .... That's definitely the optimal solution. Links to #1 as well.

@AnujanM has expressed interest in working on this.

Directory naming

Current directory name is the page id, perhaps scrape the page title to get the test's name and use that instead?

Verbose mode

Add a verbose mode to show updates as pages are scraped / files are downloaded. Not sure what the alias for this should be (since -v is taken), maybe just use --verbose without an alias?