Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cyruzin/golang-tmdb
This is a Golang wrapper for working with TMDb API. It aims to support version 3.
https://github.com/cyruzin/golang-tmdb
api-wrapper go golang themoviedatabase themoviedb tmdb tmdb-api wrapper
Last synced: about 2 months ago
JSON representation
This is a Golang wrapper for working with TMDb API. It aims to support version 3.
- Host: GitHub
- URL: https://github.com/cyruzin/golang-tmdb
- Owner: cyruzin
- License: mit
- Created: 2019-01-11T22:59:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-19T14:38:32.000Z (4 months ago)
- Last Synced: 2024-08-19T17:03:34.990Z (4 months ago)
- Topics: api-wrapper, go, golang, themoviedatabase, themoviedb, tmdb, tmdb-api, wrapper
- Language: Go
- Homepage:
- Size: 531 KB
- Stars: 113
- Watchers: 2
- Forks: 31
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: changes.go
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-go - golang-tmdb - Golang wrapper for The Movie Database API v3. (Third-party APIs / Utility/Miscellaneous)
- awesome-go-extra - golang-tmdb - 01-11T22:59:33Z|2022-05-30T22:34:20Z| (Third-party APIs / Fail injection)
README
[](https://github.com/cyruzin/golang-tmdb/actions/workflows/build.yml) [](https://coveralls.io/github/cyruzin/golang-tmdb?branch=master) [](https://goreportcard.com/report/github.com/cyruzin/golang-tmdb) [](https://godoc.org/github.com/cyruzin/golang-tmdb)  [](https://github.com/Naereen/StrapDown.js/blob/master/LICENSE)
This is a Golang wrapper for working with TMDb API.
An API Key is required. To register for one, head over to [themoviedb.org](https://www.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
```sh
go get -u github.com/cyruzin/golang-tmdb
```
## Usage
To get started, import the `tmdb` package and initiate the client:
```go
import "github.com/cyruzin/golang-tmdb"
tmdbClient, err := tmdb.Init(os.Getenv("YOUR_APIKEY"))
if err != nil {
fmt.Println(err)
}
// Using v4
tmdbClient, err := tmdb.InitV4(os.Getenv("YOUR_BEARER_TOKEN"))
if err != nil {
fmt.Println(err)
}
// OPTIONAL (Recommended): Enabling auto retry functionality.
// This option will retry if the previous request fail (429 TOO MANY REQUESTS).
tmdbClient.SetClientAutoRetry()
// OPTIONAL: Set an alternate base URL if you have problems with the default one.
// Use https://api.tmdb.org/3 instead of https://api.themoviedb.org/3.
tmdbClient.SetAlternateBaseURL()
// OPTIONAL: For tests, set a custom base URL
tmdbClient.SetCustomBaseURL("http://localhost:3000")
// Get the current base URL
tmdbClient.GetBaseURL()
// 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"))
movie, err := tmdbClient.GetMovieDetails(297802, nil)
if err != nil {
fmt.Println(err)
}
fmt.Println(movie.Title)
```
With optional params:
```go
import "github.com/cyruzin/golang-tmdb"
tmdbClient, err := tmdb.Init(os.Getenv("YOUR_APIKEY"))
if err != nil {
fmt.Println(err)
}
// Using v4
tmdbClient, err := tmdb.InitV4(os.Getenv("YOUR_BEARER_TOKEN"))
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:
```go
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](https://github.com/cyruzin/golang-tmdb/tree/master/examples).
## 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](https://github.com/cyruzin/golang-tmdb/blob/master/CONTRIBUTING.md).
### Tests
For local testing, just run:
```go
go test -v
```
## License
MIT