Giter VIP home page Giter VIP logo

tweet-collector's Introduction

Tweet Collector

Simple periodic tweet collector.

npm install --save tweet-collector
var TweetCollector = require('tweet-collector');
var tweetCollector = new TweetCollector(twitterCredentials, {
  batch_size: 100,
  interval: 10, // seconds
  search_params: {
    q: 'comma,separated,keywords'
  }
});
tweetCollector.start();
tweetCollector.on('fetch', function(tweetsArray) {
  console.log(tweetsArray);
});

API

TweetCollector(twitterCredentials, settings)

Instantiate a TweetCollector.

Example:

var tweetCollector = new TweetCollector(twitterCredentials, settings);

search_params

See Twitter API Docs.

tweetCollector.start(searchParams)

Starts tweet collector instance.

tweetCollector.stop()

Stops tweet collector instance.

tweetCollector.on('fetch', onTweetFetch)

tweetCollector.on('fetch', function onTweetFetch(tweetsArray) {
  console.log(tweetsArray);
});

CLI

$ npm install -g tweet-collector
$ tweet-collector -h

  Usage: tweetcollector [options]

  Options:

    -h, --help                output usage information
    -t --twittercfg <path>    twitter credetinals configuration file
    -k --keywords "<string>"  comma separated keywords to search
    -b --batch-size <number>  twitter search batch size
    -i --interval <number>    twitter search interval window in seconds

$ tweet-collector -t path/to/cfg.json -k "comma,separated,keywords" -b 50 -i 60

See config/twitter.json for Twitter credentials configuration.

Handling multiple collector instances

See tweet-collector-supervisor package.

tweet-collector's People

Contributors

viniciusbo avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.