TrendingGitlab

README

@TrendingGithub

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

Follow us at @TrendingGithub.

Important: This is no official GitHub or Twitter product.

Features

• Tweets trending projects every 30 minutes
• Refreshes the configuration of twitters URL shortener t.co every 24 hours
• Greylisting of repositories for 45 days (to avoid tweeting a project multiple times in a short timeframe)
• Maximum use of 140 chars per tweet to fill up with information
• Debug / development mode
• Multiple storage backends (currently Redis and in memory)

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 little 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

1. Download the latest release
2. Extract the archive (zip / tar.gz)
3. Start the bot: ./TrendingGithub -debug

For linux this can look like:

curl -L  https://github.com/andygrunwald/TrendingGithub/releases/download/v0.1.0/TrendingGithub-v0.1.0-linux-amd64.tar.gz -o TrendingGithub-v0.1.0-linux-amd64.tar.gz
tar xzvf TrendingGithub-v0.1.0-linux-amd64.tar.gz
cd TrendingGithub-v0.1.0-linux-amd64
./TrendingGithub -debug

Usage

$ ./TrendingGithub -help
Usage of ./TrendingGithub:
  -config string
    	Path to configuration file.
  -debug
    	Outputs the tweet instead of tweet it. Useful for development.
  -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 avoids using the Twitter API for tweet purposes and outputs the tweet on stdout.

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 these settings mentioned above are necessary to use the Twitter API and to set up a tweet by your application. You can get those settings by Twitter's application management.

Redis

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

redis contains the connection details to the Redis server. This Redis server is used for blacklisting projects that were 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 :6379 as a shortcut.

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.