orc-twitter-music v0.1.0

orc-twitter-music

Turns Twitter streams and searches into pleasing melodies using Orchestrate.

Install

To install, you'll need Node.js. Once you've got it install, just use NPM:

npm install -g orc-twitter-music

Usage

First off, orc-twitter-music needs your Twitter app credentials to listen in on Twitter's happenings, and an Orchestrate API key to save the data. To get them, see Getting Credentials. Then:

orc-twitter-music config \
--orchestrate_api_key ORCHESTRATE_API_KEY \
--twitter_api_key TWITTER_API_KEY \
--twitter_api_secret TWITTER_API_SECRET \
--twitter_access_token TWITTER_ACCESS_TOKEN \
--twitter_access_token_secret TWITTER_ACCESS_TOKEN_SECRET

This saves your credentials to ~/.orc_twitter_music.json. Once you've configured orc-twitter-music, you're ready to compose:

orc-twitter-music
# Now turning Twitter into music~

To track specific terms and turn them into music, do this:

orc-twitter-music --search "#yesallwomen,tech"
# Now turning Twitter into music~

Getting Credentials

Don't know where to get your TWITTER_API_KEY or your ORCHESTRATE_API_KEY? Follow along:

Twitter

1. Create an application
2. Click "manage API Keys"
3. API key is your TWITTER_API_KEY
4. API secret is your TWITTER_API_SECRET
5. Click "Create my access tokens"
6. Watch this seal learning to swim while you wait for your access tokens to generate
7. Refresh the API keys page; your access tokens should appear.
8. Access token is your TWITTER_ACCESS_TOKEN
9. Access token secret is your TWITTER_ACCESS_TOKEN_SECRET
10. echo 'you did it' | say

Orchestrate.io

1. Sign up for Orchestrate.io
2. Create an application.
3. See that value under API Keys? That's your ORCHESTRATE_API_KEY.
4. echo 'you did it' | say

Tests

Currently, and regrettably, you need live credentials to run the test suite. To set them, do this:

export ORCHESTRATE_API_KEY=...
export TWITTER_API_KEY=...
export TWITTER_API_SECRET=...
export TWITTER_ACCESS_TOKEN=...
export TWITTER_ACCESS_TOKEN_SECRET=...

Then, just:

npm test

License

ASLv2