torrent-files-library

Scan directories to build a library of media files (movie or tv show) that follows torrent naming conventions

What to do with this library ?

A lot of things :

• Basic listing purposes :
  • List found movies
  • List each found tv serie
  • Detect the category of each file
• Filtering purposes :
  • Filter movies based on search parameters
  • Filter tv-shown based on search parameters
• Miscellaneous purposes
  • Create custom playlist(s)
• ...

Don't hesitate to suggest new features : it is always worthy :)

Documentation

For more examples and API details, see API documentation with manual

Installation

For npm users :

$ npm install --save torrent-files-library

for Yarn :

$ yarn add torrent-files-library

Test

npm test

To generate a test coverage report:

npm run coverage

Contributing

• If you're unsure if a feature would make a good addition, you can always create an issue first.
• We aim for 100% test coverage. Please write tests for any new functionality or changes.
• Any API changes should be fully documented.
• Make sure your code meets our linting standards. Run npm run lint to check your code.
• Be mindful of others when making suggestions and/or code reviewing.