Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/popcorn-official/popcorn-sdk
SDK for Popcorn Time applications making it easier to retrieve movies / shows with metadata
https://github.com/popcorn-official/popcorn-sdk
metadata movie popcorn popcorn-sdk sdk shows
Last synced: 3 months ago
JSON representation
SDK for Popcorn Time applications making it easier to retrieve movies / shows with metadata
- Host: GitHub
- URL: https://github.com/popcorn-official/popcorn-sdk
- Owner: popcorn-official
- Created: 2018-09-25T19:35:26.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-01-03T17:22:42.000Z (about 2 years ago)
- Last Synced: 2024-11-01T15:17:06.585Z (3 months ago)
- Topics: metadata, movie, popcorn, popcorn-sdk, sdk, shows
- Language: JavaScript
- Homepage:
- Size: 327 KB
- Stars: 14
- Watchers: 3
- Forks: 16
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Popcorn SDK
 [](https://npm-stat.com/charts.html?package=popcorn-sdk) [](https://github.com/tripss/popcorn-sdk/issues) [](https://david-dm.org/tripss/popcorn-sdk#info=dependencies)
[](http://isitmaintained.com/project/tripss/popcorn-sdk "Average time to resolve an issue") [](http://isitmaintained.com/project/tripss/popcorn-sdk "Percentage of issues still open")[](https://gitter.im/pct-org/Lobby)
> SDK for Popcorn Time applications making it easier to retrieve movies / shows with meta data
### Installation
```shell
$ npm install --save popcorn-sdk
```
## Examples
```js
import SDK from 'popcorn-sdk'
const movies = await SDK.getMovies()
const movie = await SDK.getMovie({ ids: { imdb: '' } })
const shows = await SDK.getShows()
const show = await SDK.getShow({ ids: { imdb: '', tmdb: '' }}) // One of the two, imdb is preferred
// Or for slower internet connections you can partial load a show
const showBasic = await SDK.getBasicShow(imdbId)
// getShowMeta retrieves data from The Movie DB for better episode info and season / episode images
// Basically runs getShowIds and getShowSeasonsMeta
const showWithMeta = await SDK.getShowMeta(showBasic)
// To only retrieve the ids for a show
const showWithIds = await SDK.getShowIds({ids: { imdb: '', tmdb: '' }})
// To only retrieve the seasons meta
const showWithSeasons = await SDK.getShowSeasonsMeta(showBasic)
// To retrieve recommendations for a certain show
const recommendations = await SDK.getShowRecommendations({ ids: { tmdb: '' } })
```
### Adapters
You can add adapters handy for if you want to add attributes to movies / shows
```js
import SDK from 'popcorn-sdk'
import DefaultAdapter from 'popcorn-sdk/Adapter'
class MyAdapter extends DefaultAdapter {
/**
* Get's called after the movies are fetched and before they are returned
*
* @param movies
* @returns {*}
*/
checkMovies = movies => movies
/**
* Get's called after the movie is fetched and before they it is returned
*
* @param movie
* @returns {*}
*/
checkMovie = movie => movie
/**
* Get's called after the shows are fetched and before they are returned
*
* @param shows
* @returns {*}
*/
checkShows = shows => shows
/**
* Get's called after the show is fetched and before they it is returned
*
* @param show
* @returns {*}
*/
checkShow = show => show
}
SDK.addAdapter(new MyAdapter())
```
### Movie output
```JSON
// TODO
```
### Show output
```JSON
// TODO
```
## [License](https://github.com/tripss/popcorn-native/blob/master/LICENSE)
This project is [MIT licensed](./LICENSE).
## Collaboration
If you have questions or [issues](https://github.com/TriPSs/popcorn-sdk/issues), please [open an issue](https://github.com/TriPSs/popcorn-sdk/issues/new)!