trendinggithub

TrendingGithub

A twitter bot (@TrendingGithub) to tweet trending repositories and developers from GitHub. Follow us at @TrendingGithub.

Important note: This is no official GitHub or Twitter product.

Motivation

I love to discover new tools, new projects, new languages, new people who share the same passion like me, new coding best practices, new exciting ideas. And i use twitter a lot and have to less time to check trending repositories and developers on a daily basis.

Why not combine both to save time, favorite projects and developers and spread them by retweets?

Installation

TODO

Usage

$ TrendingGithub --help

Usage of ./TrendingGithub:
  --config="": Path to configuration file.
  --debug: Outputs the tweet instead of tweet it. Useful for development.
  --pidfile="": Write the process id into a given file.
  --version: Outputs the version number and exits.

The --config parameter is required. See Configuration chapter for details.

--debug is quite useful for development. It doesn`t output special information. It only avoid using the twitter API for tweet purposes and outputs the tweet on stdout.

--pidfile is useful to run this process in production and observing it by a monitoring tool like Nagios, Icinga, Monit, supervisord or similar.

Configuration

The configuration is based on a JSON file. You can use the config.json.dist file as base.

Twitter

"twitter": {
    "consumer-key": "",
    "consumer-secret": "",
    "access-token": "",
    "access-token-secret": ""
  },

All this settings mentioned above are necessary to use the twitter API and to setup a tweet by your application. You can get those settings by twitters application management.

Redis

"redis": {
    "url": ":6379",
    "auth": ""
  }

redis contains the connection details to the Redis server. This Redis server is used as blacklisting of projects that was already tweeted.

url is the address of the redis server in format ip:port. Example: 192.168.0.12:6379. If your server is running on localhost you can use the shortcut of :6379.

auth is the authentication string necessary for your redis server if you use the Authentication feature.

License

This project is released under the terms of the MIT license.