filmigo

package module
v0.2.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 7, 2024 License: MIT Imports: 2 Imported by: 0

README

filmigo
Golang API Wrapper for Imdb Omdb and JustWatch
Homepage Releases Documentation

filmigo

codecov Go Report Card Go Build Go Reference

filmigo is a library designed to make accessing movie databases as simple as possible in Go. It provides coverage of many api methods with close to no configuration and in-built configurable caching.

Installation

Install the latest version of filmigo from github.

go get github.com/Jisin0/filmigo@latest

Quickstart

All the examples below fetch full data about the movie Inception with it's imdbId or JustWatchId respectfully assuming there are no errors. Detailed examples can be found at the root of each package.

Imdb
import "github.com/Jisin0/filmigo/imdb"

func main() {
   client := imdb.NewClient()

   movie, _ := client.GetMovie("t1375666")
   movie.PrettyPrint()
}

More Examples

Omdb
import "github.com/Jisin0/filmigo/omdb"

func main() {
   client := omdb.NewClient("your_api_key")

   movie, _ := client.GetMovie("t1375666")
   movie.PrettyPrint()
}

More Examples

JustWatch

The justwatch id of a title can inly be obtained from search results. You can alsu use the justwatch url of the movie which is more common within justwatch.

import "github.com/Jisin0/filmigo/justwatch"

func main() {
   client := justwatch.NewClient()

   movie, _ := client.GetTitle("tm92641")
   movie.PrettyPrint()
}

More Examples

Disclaimer

  • This product is only for educational purposes and is not meant for commercial usage .
  • This product uses the apis of imdb, omdb and juswatch but is by no means endorsed nor certified by any of them.
  • This product uses apis not intended for public use.
  • This product does not use justwatch's official partners api.
  • This product comes with no warranty.

Please read the privacy policy of the respective platform before using this product.

Supported Sites

TMDB is not currently supported as there is already go-tmdb which provides full coverage of all api methods.

Contributing

filmigo is an open-source project and your contribution is very much appreciated. If you'd like to contribute, simply fork the repository, commit your changes and send a pull request. If you have any questions, feel free to ask.

License

The MIT License (MIT)

(c) Jisin0

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Documentation

Overview

filmigo is a library designed to make accessing movie databases as simple as possible in Go. It currently supports imdb, omdb and justwatch.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PrintJSON

func PrintJSON(val interface{}, indent string)

PrintJSON prints out a struct in json.

Types

This section is empty.

Directories

Path Synopsis
Package cache offers easy-to-use file based caching through json to easily cache data with minimal effort.
Package cache offers easy-to-use file based caching through json to easily cache data with minimal effort.
Package encode facilitates encoding data based on struct tags to simplify development.
Package encode facilitates encoding data based on struct tags to simplify development.
The imdb package is a collection of methods to get data from imdb using it's official api or webscraping.
The imdb package is a collection of methods to get data from imdb using it's official api or webscraping.
constants
Constants used across the imdb package.
Constants used across the imdb package.
Package justwatch uses justwathch's graphql api used on their website and apps.
Package justwatch uses justwathch's graphql api used on their website and apps.
Package omdb is an api wrapper of the single rout Open Movie DataBase (omdapi.com).
Package omdb is an api wrapper of the single rout Open Movie DataBase (omdapi.com).
Global types and functions used across packages.
Global types and functions used across packages.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL