nkt

npm-keyword-twitterbot

Tweet updated NPM modules based on keywords

Showing:

Popularity

Downloads/wk

0

GitHub Stars

2

Maintenance

Last Commit

5yrs ago

Contributors

1

Package

Dependencies

5

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

npm-keyword-twitterbot

npm

This library allows you to automatically tweet new NPM modules based on keywords.

Usage

require('npm-keyword-twitterbot')({
    // Specify a local file to keep the cache.
    local_cache_file: __dirname + '/cache_modules.json',

    // S3 settings to save the file on your S3 bucket
    s3_region: 'us-east-1',
    s3_access_key: '',
    s3_secret_access_key: '',
    s3_bucket_name: '',
    s3_file_key: 'npm-keyword-twitterbot/cache_modules.json',

    // Twitter key/secret for the app
    twitter_consumer_key: '',
    twitter_consumer_secret: '',

    // Twitter tokens for the user
    twitter_access_token: '',
    twitter_access_token_secret: '',

    npm_keyword: [
        'keyword1',
        'keyword2'
    ],

    // Enable this to use the homepage url set in package.json instead of the npm url
    use_homepage_url: true,

    tweet_hashtags: ''
});

Example

The ReactJSnpm twitter bot is an example of bot using this script.

Have a bot? Send a PR!

How to use

  • Create a Twitter app for your bot: https://apps.twitter.com/
  • Create a specific Twitter user for your bot and retrieve its tokens.
  • Create a bot like the one in the usage section.
  • Add a cron job to start your bot. The cron job should run the script at least every 30 minutes.

License

MIT, see LICENSE.md for details.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial