RedditEasy is an API wrapper for getting posts using the Reddit JSON API with both sync and async options
Project description
RedditEasy
RedditEasy is an API wrapper for getting posts using the Reddit JSON API with both sync and async options
Install
To install RedditEasy, do:
pip install redditeasy
OR
python -m pip install redditeasy
Documentation
Docs can be found here
Async RedditEasy
Yes, there is an async version of RedditEasy. To use it, you need to use the Async classes. Which are AsyncSubreddit
and AsyncUser
Here is a small example on using AsyncSubreddit
: https://github.com/MakufonSkifto/RedditEasy/blob/main/examples/async_meme.py
You can and should use this in a discord.py bot. The normal classes could cause a blocking in an async program.
This will not work outside an async function whatsoever.
Usage
The module will use its own default client info if AT LEAST ONE of these are not given: client_id
, client_secret
and user_agent
.
Without Reddit API client info
This method is not suggested as it may be slow and throw errors more often
import redditeasy
import datetime
# To get your Reddit API client info go to
# https://www.reddit.com/prefs/apps
# and create an app
# For more detailed explanation, see this image: https://i.imgur.com/Ri13AQu.png
post = redditeasy.Subreddit(subreddit="dankmemes") # Subreddit name
postoutput = post.get_post()
# Formatted version of created_at
formatted_time = datetime.datetime.fromtimestamp(postoutput.created_at).strftime("%d/%m/%Y %I:%M:%S UTC")
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: {formatted_time}\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}\n"
f"Comment count: {postoutput.comment_count}\n"
f"Is Media?: {postoutput.is_media}\n"
f"Subreddit Name: r/{postoutput.subreddit_name}\n"
f"Content Type: {postoutput.content_type}")
With Reddit API client info
import redditeasy
import datetime
# To get your Reddit API client info go to
# https://www.reddit.com/prefs/apps
# and create an app
# For more detailed explanation, see this image: https://i.imgur.com/Ri13AQu.png
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()
# Formatted version of created_at
formatted_time = datetime.datetime.fromtimestamp(postoutput.created_at).strftime("%d/%m/%Y %I:%M:%S UTC")
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: {formatted_time}\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}\n"
f"Comment count: {postoutput.comment_count}\n"
f"Is Media?: {postoutput.is_media}\n"
f"Subreddit Name: r/{postoutput.subreddit_name}\n"
f"Content Type: {postoutput.content_type}")
More examples are in the examples folder
Getting Reddit API client info
To get your Reddit API client info go to https://www.reddit.com/prefs/apps and create a script.
(You don't have to fill "redirect_uri")
Operating Systems
All of RedditEasy's versions were tested in Windows
, Linux (Ubuntu)
and MacOS
Errors
The module will raise redditeasy.exceptions.RequestError
if there was an error with the request. Traceback will show the details about the error
The module will raise redditeasy.exceptions.EmptyResult
if the given user / subreddit is empty
Issues
If you have any issues with RedditEasy, please report them via the issue tracker
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for redditeasy-3.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 380bc27e431141e5d9376b4fb21674d9c34d3d8c58aff389f5051b43d0569783 |
|
MD5 | 9705b6ad7733dee00eaa9aad77424522 |
|
BLAKE2b-256 | 0d7436b2c91f14c12210383c8446ea7d166138491c75d3791eed66638d63d9bb |