amalgamatic-libguides

LibGuides plugin for amalgamatic

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
00Feb 2, 2016Sep 17, 2014Minified + gzip package size for amalgamatic-libguides in KB

Readme

Build Status

amalgamatic-libguides

LibGuides plugin for Amalgamatic

Installation

Install amalgamatic and this plugin via npm:

npm install amalgamatic amalgamatic-libguides

Usage

var amalgamatic = require('amalgamatic'),
    libguides = require('amalgamatic-libguides');

// Set the URL to point to your LibGuides search page
libguides.setOptions({url: 'http://guides.ucsf.edu/srch.php'});

// If there are additional URL parameters you want to specify, use the urlParameters option:
//    libguides.setOptions({urlParameters: {foo: 'bar', boo: 'baz'}};

// Add this plugin to your Amalgamatic instance along with any other plugins you've configured.
amalgamatic.add('libguides', libguides);

//Use it!
var callback = function (err, results) {
    if (err) {
        console.dir(err);
    } else {
        results.forEach(function (result) {
            console.log(result.name);
            console.dir(result.data);
        });
    }
};

amalgamatic.search({searchTerm: 'medicine'}, callback);

Requirements

This uses phantomjs to scrape the search page because the LibGuides API does not return the same results in the same order. Therefore, you must have phantomjs installed to use this plugin.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.