https://github.com/hyde46/reddit_api_rs

:hammer: Toy wrapper for Reddit API written in rust
https://github.com/hyde46/reddit_api_rs

Last synced: 3 months ago
JSON representation

:hammer: Toy wrapper for Reddit API written in rust

• Host: GitHub
• URL: https://github.com/hyde46/reddit_api_rs
• Owner: Hyde46
• License: mit
• Created: 2020-07-10T12:28:04.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-12-02T17:37:46.000Z (about 3 years ago)
• Last Synced: 2024-09-14T13:50:20.600Z (4 months ago)
• Language: Rust
• Homepage:
• Size: 102 KB
• Stars: 2
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RsReddit - Lightweight Wrapper for the Reddit Web API written with rust

## Description

RsReddit is lightweight wrapper for the Reddit Web API. The goal is to cover some useful endpoints like browsing subreddits, creating posts, commenting on posts. For a complete reference, see the [official documentation](https://www.reddit.com/dev/api/oauth). As this is a toy project, not all endpoints are expected to be implemented

## Features

Implemented endpoints:

* Get sorted posts of subreddit or frontpage

    * Top posts

    * Hot posts

    * Best posts

    * Rising posts

    * New posts

    * Controversial posts

* Comment on thread

* Reply to comments

* Get Thread comment tree

OAuth2 specific implementations:

* Authorize Client with Reddit UI ( Installed APP type. See [here](https://github.com/reddit-archive/reddit/wiki/oauth2-app-types) )

* Refresh bearer token

* Revoke bearer token

## Usage

Add to your `Cargo.toml`:

``` toml

[dependencies]

rsreddit = "0.1.3"

```

Or get it from [GitHub](https://github.com/Hyde46/reddit_api_rs).

## Getting Started

### Authorization

Currently only Installed Apps are supported.

A script using this library has to register an installed app, or authorize an existing one.

To use an existing App, or set your own app, set the environment variable CLIENT_ID as the app's ID, and CLIENT_SECRET as base64 encoded CLIENT_ID.

You can also set these values in a `.env` file, for example as shown [here](https://github.com/Hyde46/reddit_api_rs/blob/master/.env).

If you want to use your own installed app, create one over [here](https://www.reddit.com/prefs/apps). It is important to choose **installed app**.

See the [official documentation](https://github.com/reddit-archive/reddit/wiki/oauth2)

### Examples

* Reddit API endpoints

    * [Top posts](https://github.com/Hyde46/reddit_api_rs/blob/master/examples/top_posts.rs)

    * [Best posts](https://github.com/Hyde46/reddit_api_rs/blob/master/examples/best_posts.rs)

    * [Comment on post or reply to comment](https://github.com/Hyde46/reddit_api_rs/blob/master/examples/comment_thread.rs)

    * [Traverse comment tree](https://github.com/Hyde46/reddit_api_rs/blob/master/examples/traverse_comment_tree.rs)

* Authorization Examples

    * [Authorize User](https://github.com/Hyde46/reddit_api_rs/blob/master/examples/authorize_user.rs)

    * [Refresh bearer token](https://github.com/Hyde46/reddit_api_rs/blob/master/examples/refresh_token.rs)

    * [Revoke bearer token](https://github.com/Hyde46/reddit_api_rs/blob/master/examples/revoke_token.rs)

## Changelog

See [changelog](https://github.com/Hyde46/reddit_api_rs/blob/master/CHANGELOG.md) for release history

## Contribution

Pull requests, code reviews, general feedback are welcome!