https://github.com/jakemmarsh/reddit-tumblr-bot

a Reddit-to-Tumblr bot in Python
https://github.com/jakemmarsh/reddit-tumblr-bot

Last synced: about 2 months ago
JSON representation

a Reddit-to-Tumblr bot in Python

• Host: GitHub
• URL: https://github.com/jakemmarsh/reddit-tumblr-bot
• Owner: jakemmarsh
• License: mit
• Created: 2014-01-29T18:26:13.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2015-02-08T19:51:10.000Z (almost 10 years ago)
• Last Synced: 2024-04-14T18:05:52.019Z (9 months ago)
• Language: Python
• Homepage:
• Size: 211 KB
• Stars: 9
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Reddit to Tumblr Bot

=====================

This is a bot written in Python using the following libraries:

- [PRAW](https://github.com/praw-dev/praw) for accessing the Reddit API

- [Pytumblr](https://github.com/tumblr/pytumblr) for accessing the Tumblr API

The purpose of this bot is to periodically query a specified subreddit via the Reddit API for newest posts. If a previous query has been executed, it will only query for posts after the latest ID. From there, it parses the post titles for the information desired for Tumblr. The Tumblr API is then utilized in order to create new posts for each retrieved Reddit post.

Bot Parameters

---------------

When initializing the Reddit-to-Tumblr bot, it accepts four parameters (not including all your API keys). They are:

- `subreddit` (str): the name of the subreddit from which to retrieve posts. Has no default.

- `queryType` (str): the type of posts to retrieve from the specified subreddit. Options are `hot` (default) and `new`.

- `timer` (int): the number of seconds to wait in between retrieving and posting. Defaults to `3600`, or 1 hour.

- `limit` (int): the maximum number of posts to retrieve from Reddit per query. Defaults to `20`.

As the project is currently configured, all of these parameters are pulled from a global configuration file. The structure and use of this configuration file is described below.

Sample Configuration File

--------------------------

The bot is currently set up to draw all API keys and parameters from a configuration file. Although this isn't required and can be changed pretty easily, it is a quick way to input all your information and get up and running. Below is how your configuration file should look if you choose to go this route:

```

[tumblr]

blogName : YOUR BLOG NAME HERE

consumerKey : YOUR TUMBLR CONSUMER KEY HERE

consumerSecret : YOUR TUMBLR CONSUMER SECRET HERE

oauthToken : YOUR TUMBLR OAUTH TOKEN HERE

oauthSecret : YOUR TUMBLR OAUTH SECRET HERE

[reddit]

userAgent : A SHORT DESCRIPTION OF YOUR BOT HERE

subreddit : THE NAME OF THE SUBREDDIT TO GET POSTS FROM HERE

queryType : EITHER hot OR new

limit : NUMBER OF POSTS TO RETRIEVE AT A TIME FROM REDDIT

[timer]

seconds : THE NUMBER OF SECONDS TO WAIT IN BETWEEN RETRIEVING/CREATING POSTS

```

**A few notes:**

- The configuration file should be titled 'settings.cfg' and should be placed in the same directory as the source `.py` files

- All parameters drawn from the config file are automatically strings. Quotes are not necessary, and for things like the number of seconds they must be cast as `int` when used (this is already done for you).