/kynigos

Kynigos, the greek word for hunter, is a reddit bot that will find listings with user specified keywords using reddit's API

Primary LanguageRuby

#Kynigos Build Status Code Climate Dependency Status

###Overview Explores reddit and subreddits for listings with specific keywords

###Installation

$ git clone git@github.com:vinnyoodles/kynigos.git

This can also be added to Rails applications as a gem.

$ gem install kynigos

The application uses Reddit's OAuth2 for authentication, so you will have to follow the instructions listed in the link to get access. You can also ask me for my authentication keys that I'm currently using.

If you do decide to create your own keys, you will have to save them as environment variables.

ENV["REDDIT_CLIENT_ID"] = 'p-jcoLKBynTLew'
ENV["REDDIT_SECRET"] = 'gko_LXELoV07ZBNUXrvWZfzE3aI'

The keys above are taken from Reddit's OAuth2 Quick Start Example

You will also need to save your reddit username and password as environment variable. This will be the account that will send the private messages

ENV["REDDIT_USERNAME"] = 'username'
ENV["REDDIT_PASSWORD"] = 'password'

###Getting started First, update lib/tasks/hunt.rake to customize your reddit account and subreddit.

Kynigos.new(username: ENV["REDDIT_USERNAME"], password: ENV["REDDIT_PASSWORD"]).
      send_prize 'reddit_account', keywords, 'subreddit'

Also, update the lib/keywords.yml file to include your keywords.

keywords:
  - Foo
  - Bar

Finally, run the command in your terminal and reap the rewards in your reddit account.

$ rake send

###Contributing Anyone is encouraged to contribute by either posting issues or submitting pull requests.

###License Kynigos is released under the MIT License.