twax v0.1.0

twax

A module for classifying twitter users by their last 100 tweets.

Use

You'll have to set the follow environment variables on process.env:

ALCHEMY_API_KEY, TWITTER_CONSUMER_KEY, TWITTER_CONSUMER_SECRET, TWITTER_ACCESS_TOKEN, TWITTER_ACCESS_TOKEN_SECRET

import Twax from 'twax';
twax = new Twax();
twax.taxonomize('quavmo').then(console.log)

Should return:

[ '/art and entertainment/music',
  '/society/unrest and war',
  '/business and industrial' ]

Installation

Download node at nodejs.org and install it, if you haven't already.

npm install twax --save

Tests

npm install
npm test

> twax@0.0.1 test /Users/gavin/Workspace/twoops
> mocha
  taxonomize
    ✓ classifies a twitter handle by the taxonomies of its post
  1 passing (97ms)

Dependencies

• bluebird: Full featured Promises/A+ implementation with exceptionally good performance
• ramda: A practical functional library for JavaScript programmers.
• twit: Twitter API client for node (REST & Streaming)
• watson-developer-cloud: Client library to use the IBM Watson Services and AlchemyAPI

Dev Dependencies

• babel-preset-stage-0: Babel preset for stage 0 plugins
• babel-register: babel require hook
• chai: BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
• chai-as-promised: Extends Chai with assertions about promises.
• dotenv: Loads environment variables from .env file
• mocha: simple, flexible, fun test framework
• mocha-as-promised: Adds “thenable” promise support to the Mocha test runner.
• sinon: JavaScript test spies, stubs and mocks.
• sinon-as-promised: Sugar methods for using sinon.js stubs with promises

Todo

• Don't expect process.env.VARIABLES on load.

License

MIT

Generated by package-json-to-readme