https://github.com/z0w0/atsaty
A tweet says a thousand yeps
https://github.com/z0w0/atsaty
Last synced: 24 days ago
JSON representation
A tweet says a thousand yeps
- Host: GitHub
- URL: https://github.com/z0w0/atsaty
- Owner: z0w0
- License: mit
- Created: 2012-10-13T06:25:45.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2014-05-05T11:53:19.000Z (about 12 years ago)
- Last Synced: 2025-08-20T14:54:20.594Z (11 months ago)
- Language: JavaScript
- Homepage: https://npmjs.org/package/atsaty
- Size: 152 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Atsaty
*A tweet says a thousand yeps...*
Atsaty acts like `yes`, but instead of always outputting yeps,
it uses [sentiment analysis](https://github.com/thisandagain/sentiment) to
find the current mood of English-speaking tweeters on Twitter.
If there are more positive tweeters than negative, it outputs yep, otherwise
it outputs nope.
```sh
$ atsaty
y
y
y
...
```
```js
var atsaty = require("atsaty");
atsaty(function(err, yep) {
if(yep) console.log("Everyone on Twitter seems to be happy");
else console.log("Tweeters are crying at the moment");
});
atsaty("from:z0w0", function(err, yep) {
if(yep) console.log("The creator of this pointless thing is happy");
else console.log("The creator is sad, T__T");
});
```
## Installation
```sh
npm install -g atsaty
```
## Usage
```
atsaty --help
Usage: atsaty [options]
Options:
-h, --help output usage information
-V, --version output the version number
-y, --yep Message to output for yep
-n, --nope Message to output for nope
```
### Examples
```sh
$ atsaty
y
y
y
...
```
```sh
$ atsaty from:z0w0
n
n
n
...
```
## API
### atsaty([query,] cb)
Uses the [Twitter Search API](https://dev.twitter.com/docs/using-search)
and sentiment analysis to figure out how Twitter is currently feeling.
If `query` is provided, then it will check the mood of a specific search
query instead of the entire Twitter community (e.g. "#racist #cats").
The callback will be called with an error or `null` as its first argument,
`false` as its second if there are no positive tweets or there
are more negative tweets than positive ones, otherwise it calls with a second
argument of `true`.