Scatterbot

Just a simple bot for scattering data all over Twitter. I'm kidding, he just retweets some things.

const Scatterbot = require('scatterbot');

const config = {
    consumer_key: 'd25fe54c17d9cb57ce698b3c37398aad',
    consumer_secret: 'bdd6131d8a8b67fc6e4a1ab13b2be26b',
    access_token_key: '400309427d9d78610b302014c948cdc7',
    access_token_secret: '4d81eee6685d46217e82378a3da581a8'
}

const bot = new Scatterbot(config);

const params = { track: '#scatter,#bot'}

bot.track(params);

Installation

npm install scatterbot

Getting Started

To use this bot, you will need valid Twitter developer credentials. Here's a guide on how to get them.

const Scatterbot = require('scatterbot');

Configuring the credentials

To start tracking the words you want, you need to pass all the credentials to the bot constructor.

const config = {
    consumer_key: 'add_consumer_key',
    consumer_secret: 'add_consumer_secret',
    access_token_key: 'add_access_token_key',
    access_token_secret: 'add_access_token_secret'
}

You could pass this credentials through environment variables too.

const config = {
    consumer_key: process.env.CONSUMER_KEY,
    consumer_secret: process.env.CONSUMER_SECRET,
    access_token_key: process.env.TACCESS_TOKEN_KEY,
    access_token_secret: process.env.ACCESS_TOKEN_SECRET
}

With the configurations added, just create your bot.

const bot = new Scatterbot(config);

Tracking!

After the initial configuration, now you are ready to track some specific terms. To pass more than one term, separate them with commas, like shown in the example below.

const params = { track: '#scatter,#bot'}

bot.track(params);

Additional Information

This package abstracts some basic functionality of the Twitter npm module to make it easy to track and retweets hashtags, facilitating the users of retweet bots and similars.

License

MIT License

Copyright (c) 2020 Hierro Duarte

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.