| CARVIEW |
reddit: Library for interfacing with Reddit's API
A library for interfacing with Reddit''s API in Haskell. Handles logins, rate-limiting and converting to and from JSON responses. Supports most user-facing Reddit API functions, as well as some moderator endpoints. Check out the readme at https://github.com/intolerable/reddit. Contributions are welcome.
[Skip to Readme]
Modules
[Index] [Quick Jump]
- Reddit
- Reddit.Actions
- Reddit.Login
- Reddit.Types
- Reddit.Types.Captcha
- Reddit.Types.Comment
- Reddit.Types.Error
- Reddit.Types.Flair
- Reddit.Types.Listing
- Reddit.Types.Message
- Reddit.Types.Moderation
- Reddit.Types.Options
- Reddit.Types.Post
- Reddit.Types.Reddit
- Reddit.Types.SearchOptions
- Reddit.Types.Subreddit
- Reddit.Types.SubredditSettings
- Reddit.Types.Thing
- Reddit.Types.User
- Reddit.Types.Wiki
Downloads
- reddit-0.3.0.0.tar.gz [browse] (Cabal source package)
- Package description (as included in the package)
Maintainer's Corner
For package maintainers and hackage trustees
Candidates
- No Candidates
| Versions [RSS] | 0.1.0.0, 0.1.1.0, 0.2.0.0, 0.2.1.0, 0.2.2.0, 0.2.2.1, 0.2.2.2, 0.2.3.0, 0.3.0.0 (info) |
|---|---|
| Dependencies | aeson (>=2), api-builder (>=0.10), base (>=4.6), bytestring (>=0.10.8), data-default-class (>=0.0.1), free (>=4), http-client (>=0.4.30), http-client-tls (>=0.2), http-types (>=0.8), network (>=2.6), text (>=1.2), time (>=1.5), transformers (>=0.4), unordered-containers (>=0.2.5), vector (>=0.10) [details] |
| License | BSD-2-Clause |
| Copyright | Copyright (c) Fraser Murray, 2013-2018 |
| Author | Fraser Murray |
| Maintainer | fraser.m.murray@gmail.com |
| Uploaded | by Intolerable at 2022-07-11T13:02:15Z |
| Category | Network |
| Home page | https://github.com/intolerable/reddit#readme |
| Bug tracker | https://github.com/intolerable/reddit/issues |
| Source repo | head: git clone https://github.com/intolerable/reddit |
| Distributions | |
| Reverse Dependencies | 1 direct, 0 indirect [details] |
| Downloads | 4992 total (25 in the last 30 days) |
| Rating | (no votes yet) [estimated by Bayesian average] |
| Your Rating |
|
| Status | Docs available [build log] Last success reported on 2022-07-11 [all 1 reports] |
Readme for reddit-0.3.0.0
[back to package description]reddit for haskell 
A Haskell library for interacting with the Reddit API.
A couple of examples
Let's get all the posts from the frontpage of Reddit and write a summary of each of them to the console:
{-# LANGUAGE OverloadedStrings #-}
import Reddit
import Reddit.Types.Post
import Control.Monad
import Control.Monad.IO.Class
import Data.Monoid
import qualified Data.Text as Text
import qualified Data.Text.IO as Text
main = runRedditAnon $ do
Listing _ _ posts <- getPosts
forM_ posts $ \post -> do
liftIO $ Text.putStrLn $
"[" <> tshow (score post) <> "] " <>
title post <> " (" <> tshow (subreddit post) <> ")"
tshow = Text.pack . show
Let's check to see which of a group of users has the highest link karma:
{-# LANGUAGE OverloadedStrings #-}
import Reddit
import Reddit.Types.User
import Data.List
import Data.Ord
usersToCheck = ["nikita-volkov", "simonmar", "bos", "roche"]
main = runRedditAnon $ do
infos <- mapM (getUserInfo . Username) usersToCheck
return $ maximumBy (comparing linkKarma) infos
Testing
Pure tests
cabal test test
This suite will only run test that don't require doing any IO. Helpful because it runs quickly and isn't subject to any network problems.
Anonymous tests
cabal test test-anon
There's also a suite of tests that can be run anonymously without having to set up a user account and an empty subreddit.
Full IO tests
cabal test test-io
The test test suite will run the tests that don't rely on doing any IO, but the test-io should be used too to ensure that IO functions do what they're supposed to do. If you want to run the IO suite, add a file test_config.yaml to the reddit/ directory, like this:
username: my_reddit_username
password: my_reddit_password
subreddit: test_subreddit # A subreddit that the user has moderator access to
client_id: MY_CLIENT_ID # Your reddit app client ID
client_secret: MY_CLIENT_SECRET # Your reddit app client secret
Your app client and secret can be found in your reddit preferences