Code Monkey home page Code Monkey logo

reddit_api_rs's Introduction

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. 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 )
  • Refresh bearer token
  • Revoke bearer token

Usage

Add to your Cargo.toml:

[dependencies]
rsreddit = "0.1.3"

Or get it from GitHub.

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.

If you want to use your own installed app, create one over here. It is important to choose installed app. See the official documentation

Examples

Changelog

See changelog for release history

Contribution

Pull requests, code reviews, general feedback are welcome!

reddit_api_rs's People

Contributors

hyde46 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.