golang-tmdb
golang-tmdb copied to clipboard
This is a Golang wrapper for working with TMDb API. It aims to support version 3.
This is a Golang wrapper for working with TMDb API. It aims to support version 3.
An API Key is required. To register for one, head over to themoviedb.org.
This product uses the TMDb API but is not endorsed or certified by TMDb.
Requirements
- Go 1.13.x or higher. We aim to support the latest supported versions of go.
Installation
go get -u github.com/cyruzin/golang-tmdb
Usage
To get started, import the tmdb
package and initiate the client:
import "github.com/cyruzin/golang-tmdb"
tmdbClient, err := tmdb.Init(os.GetEnv("YOUR_APIKEY"))
if err != nil {
fmt.Println(err)
}
// OPTIONAL: Setting a custom config for the http.Client.
// The default timeout is 10 seconds. Here you can set other
// options like Timeout and Transport.
customClient := http.Client{
Timeout: time.Second * 5,
Transport: &http.Transport{
MaxIdleConns: 10,
IdleConnTimeout: 15 * time.Second,
}
}
tmdbClient.SetClientConfig(customClient)
// OPTIONAL: Enable this option if you're going to use endpoints
// that needs session id.
//
// You can read more about how this works:
// https://developers.themoviedb.org/3/authentication/how-do-i-generate-a-session-id
tmdbClient.SetSessionID(os.GetEnv("YOUR_SESSION_ID"))
// OPTIONAL (Recommended): Enabling auto retry functionality.
// This option will retry if the previous request fail (429 TOO MANY REQUESTS).
tmdbClient.SetClientAutoRetry()
movie, err := tmdbClient.GetMovieDetails(297802, nil)
if err != nil {
fmt.Println(err)
}
fmt.Println(movie.Title)
With optional params:
import "github.com/cyruzin/golang-tmdb"
tmdbClient, err := tmdb.Init(os.GetEnv("YOUR_APIKEY"))
if err != nil {
fmt.Println(err)
}
options := map[string]string{
"language": "pt-BR",
"append_to_response": "credits,images",
}
movie, err := tmdbClient.GetMovieDetails(297802, options)
if err != nil {
fmt.Println(err)
}
fmt.Println(movie.Title)
Helpers:
Generate image and video URLs:
import "github.com/cyruzin/golang-tmdb"
tmdbClient, err := tmdb.Init(os.GetEnv("YOUR_APIKEY"))
if err != nil {
fmt.Println(err)
}
options := map[string]string{
"append_to_response": "videos",
}
movie, err := tmdbClient.GetMovieDetails(297802, options)
if err != nil {
fmt.Println(err)
}
fmt.Println(tmdb.GetImageURL(movie.BackdropPath, tmdb.W500))
// Output: https://image.tmdb.org/t/p/w500/bOGkgRGdhrBYJSLpXaxhXVstddV.jpg
fmt.Println(tmdb.GetImageURL(movie.PosterPath, tmdb.Original))
// Ouput: https://image.tmdb.org/t/p/original/bOGkgRGdhrBYJSLpXaxhXVstddV.jpg
for _, video := range movie.MovieVideosAppend.Videos.MovieVideos.Results {
if video.Key != "" {
fmt.Println(tmdb.GetVideoURL(video.Key))
// Output: https://www.youtube.com/watch?v=6ZfuNTqbHE8
}
}
For more examples, click here.
Performance
Getting Movie Details:
Iterations | ns/op | B/op | allocs/op |
---|---|---|---|
19 | 60886648 | 60632 | 184 |
Multi Search:
Iterations | ns/op | B/op | allocs/op |
---|---|---|---|
16 | 66596963 | 107109 | 608 |
Contributing
To start contributing, please check CONTRIBUTING.
Tests
For local testing, just run:
go test -v
License
MIT