Skip to main content

RedditEasy is an API wrapper for the Reddit JSON API

Project description

Documentation Status License GitHub stars PyPI version

RedditEasy

RedditEasy is an API wrapper for the Reddit JSON API

Install

To install RedditEasy, do:

pip install redditeasy

OR

python -m pip install redditeasy

Documentation

Docs can be found here

Usage

import redditeasy

"""
To get your client ID, client secret and user agent go to:
https://www.reddit.com/prefs/apps
and create an app
"""


post = redditeasy.Subreddit(subreddit="dankmemes",   #Subreddit name
                            client_id="",            #Your client ID
                            client_secret="",        #Your client secret
                            user_agent=""            #Your user agent (ex: ClientName/0.1 by YourUsername")
                            )

postoutput = post.get_post()

print(f"Posts Title: {postoutput.title}\n"
      f"Posts Content: {postoutput.content}\n"
      f"Posts Author: u/{postoutput.author}\n"
      f"Posts URL: {postoutput.post_url}\n"
      f"Spoiler?: {postoutput.spoiler}\n"
      f"Post Created At: {postoutput.created_at}\n"
      f"Posts Upvote Count: {postoutput.score}\n"
      f"Posts Award Count: {postoutput.total_awards}\n"
      f"NSFW?: {postoutput.nsfw}\n"
      f"Post Flair: {postoutput.post_flair}\n"
      f"User Flair: {postoutput.author_flair}\n"
      f"Subreddit Subscribers: {postoutput.subreddit_subscribers}")

More examples are in the examples folder

Errors

The module will raise KeyError if the given user / subreddit is not found

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

redditeasy-2.2.0.tar.gz (5.3 kB view hashes)

Uploaded Source

Built Distribution

redditeasy-2.2.0-py3-none-any.whl (18.3 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page