❤
npm
Sign UpSign In

movie-list

4.0.0 • Public • Published

movie-list Build Status Coverage Status

A node program to show a list of your movies sorted by rating

Installation

As cli tool

$ [sudo] npm install movie-list -g

Programmatically

$ [sudo] npm install movie-list

Usage

CLI

$  movie-list 0.0.0 - A node program to show a list of your movies sorted by rating
     
   USAGE
 
     movie-list [path]
 
   ARGUMENTS
 
     [path]      Path to movies directory      optional      default: "D:\\Downloads"
 
   OPTIONS
 
     -s, --sort <property>       Sort by property (title|year|rating|runtime)      optional      default: "rating"
     -o, --order <asc|desc>      Order of the sorting                              optional      default: "desc"  
     -t, --table                 Prints the list in a table                        optional                       
     -j, --json                  Prints the list data as json                      optional                       
 
   COMMANDS
 
     key <key>           set api key to omdb                
     help <command>      Display help for a specific command
 
   GLOBAL OPTIONS
 
     -h, --help         Display help                                      
     -V, --version      Display version                                   
     --no-color         Disable colors                                    
     --quiet            Quiet mode - only displays warn and error messages
     -v, --verbose      Verbose mode - will also output debug messages    

Programmatically

import movieList from 'movie-list';
 
movieList.saveKey({apiKey: 'my-key'});
 
movieList({source: '/path/to/movies/folder'})
  .then((listData) => {
    // listData -> data found on the movies
  });

Options

Option Description Default
movieGlob The glob to use when searching movie files, built with video-extensions ['**/*.{' + videoExtensions.join(',') + '}', '!**/*{sample,Sample,rarbg.com,RARBG.com}*.*']
source the path to the movies folder, glob searches here process.cwd()
concurrentRequests Number of concurrent requests to omdb 15
apiKey The api key to use Tries to get the value saved from the saveKey function

Api key

This library uses omdb behind the scenes. You need to create a key here. Save the key with: movie-list key my-key.

License

MIT © Noam Okman

Readme

Keywords

Package Sidebar

Install

npm i movie-list

Repository

github.com/noamokman/movie-list

Homepage

github.com/noamokman/movie-list

Weekly Downloads

10

Version

4.0.0

License

MIT

Last publish

Collaborators

  • noamokman
Try on RunKit
Report malware