127 lines
3.4 KiB
Markdown
127 lines
3.4 KiB
Markdown
<div align='center'>
|
|
<br />
|
|
<img src='./images/logo.png' alt='go-reddit logo' height='150'>
|
|
|
|
---
|
|
|
|
<div id='badges' align='center'>
|
|
|
|
[](https://github.com/vartanbeno/go-reddit/actions)
|
|
[](https://goreportcard.com/report/github.com/vartanbeno/go-reddit)
|
|
[](https://pkg.go.dev/github.com/vartanbeno/go-reddit/reddit)
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
## Overview
|
|
|
|
**Featured in [issue 327 of Golang Weekly](https://golangweekly.com/issues/327) 🎉**
|
|
|
|
go-reddit is a Go client library for accessing the Reddit API.
|
|
|
|
You can view Reddit's official API documentation [here](https://www.reddit.com/dev/api/).
|
|
|
|
## Install
|
|
|
|
To get a specific version from the list of [versions](https://github.com/vartanbeno/go-reddit/releases):
|
|
|
|
```sh
|
|
go get github.com/vartanbeno/go-reddit@vX.Y.Z
|
|
```
|
|
|
|
Or for the latest version:
|
|
|
|
```sh
|
|
go get github.com/vartanbeno/go-reddit
|
|
```
|
|
|
|
## Usage
|
|
|
|
Make sure to have a Reddit app with a valid client id and secret. [Here](https://github.com/reddit-archive/reddit/wiki/OAuth2-Quick-Start-Example#first-steps) is a quick guide on how to create an app and get credentials.
|
|
|
|
```go
|
|
package main
|
|
|
|
import "github.com/vartanbeno/go-reddit/reddit"
|
|
|
|
func main() {
|
|
withCredentials := reddit.WithCredentials("id", "secret", "username", "password")
|
|
client, _ := reddit.NewClient(withCredentials)
|
|
}
|
|
```
|
|
|
|
You can pass in a number of options to `NewClient` to further configure the client (see [reddit/reddit-options.go](reddit/reddit-options.go)). For example, to use a custom HTTP client:
|
|
|
|
```go
|
|
httpClient := &http.Client{Timeout: time.Second * 30}
|
|
client, _ := reddit.NewClient(withCredentials, reddit.WithHTTPClient(httpClient))
|
|
```
|
|
|
|
### Read-Only Mode
|
|
|
|
The global `DefaultClient` variable is a valid, read-only client with limited access to the Reddit API, much like a logged out user. You can initialize your own via `NewReadonlyClient`:
|
|
|
|
```go
|
|
client, _ := reddit.NewReadonlyClient()
|
|
```
|
|
|
|
## Examples
|
|
|
|
<details>
|
|
<summary>Configure the client from environment variables.</summary>
|
|
|
|
```go
|
|
client, _ := reddit.NewClient(reddit.FromEnv)
|
|
```
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Submit a comment.</summary>
|
|
|
|
```go
|
|
comment, _, err := client.Comment.Submit(context.Background(), "t3_postid", "comment body")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fmt.Printf("Comment permalink: %s\n", comment.Permalink)
|
|
```
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Upvote a post.</summary>
|
|
|
|
```go
|
|
_, err := client.Post.Upvote(context.Background(), "t3_postid")
|
|
if err != nil {
|
|
return err
|
|
}
|
|
```
|
|
</details>
|
|
|
|
<details>
|
|
<summary>Get r/golang's top 5 posts of all time.</summary>
|
|
|
|
```go
|
|
posts, _, err := client.Subreddit.TopPosts(context.Background(), "golang", &reddit.ListPostOptions{
|
|
ListOptions: reddit.ListOptions{
|
|
Limit: 5,
|
|
},
|
|
Time: "all",
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
fmt.Printf("Received %d posts.\n", len(posts))
|
|
```
|
|
</details>
|
|
|
|
More examples are available in the [examples](examples) folder.
|
|
|
|
## Design
|
|
|
|
The package design is heavily inspired from [Google's GitHub API client](https://github.com/google/go-github) and [DigitalOcean's API client](https://github.com/digitalocean/godo).
|
|
|
|
## License
|
|
|
|
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|