Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jy95/torrent-files-library
Scan directories to build a library of media files (movie or tv show) that follows torrent naming conventions
https://github.com/jy95/torrent-files-library
javascript library movie npm-package scan-directories torrent torrent-naming-conventions tv-series tv-shows
Last synced: 17 days ago
JSON representation
Scan directories to build a library of media files (movie or tv show) that follows torrent naming conventions
- Host: GitHub
- URL: https://github.com/jy95/torrent-files-library
- Owner: jy95
- License: mit
- Created: 2017-08-20T21:50:34.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-04-16T02:55:36.000Z (3 months ago)
- Last Synced: 2024-06-16T07:20:09.697Z (26 days ago)
- Topics: javascript, library, movie, npm-package, scan-directories, torrent, torrent-naming-conventions, tv-series, tv-shows
- Language: JavaScript
- Homepage: https://jy95.github.io/torrent-files-library/
- Size: 4.7 MB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-stars - torrent-files-library
README
# torrent-files-library [](https://travis-ci.org/jy95/torrent-files-library) [](https://coveralls.io/github/jy95/torrent-files-library?branch=master) [](https://david-dm.org/jy95/torrent-files-library) [](https://david-dm.org/jy95/torrent-files-library?type=dev) [](https://opensource.org/licenses/MIT) [](https://github.com/semantic-release/semantic-release) [](https://gitter.im/torrent-files-library-/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [](https://greenkeeper.io/)
> Scan directories to build a library of media files (movie or tv show) that follows torrent naming conventions
PS: see the repository [mediaScan](https://github.com/jy95/mediaScan) for the TypeScript version of this lib.
## What to do with this library ?
A lot of things :
* Basic listing purposes :
* [List found movies](https://jy95.github.io/torrent-files-library/manual/listFoundMovies.html)
* [List each found tv serie](https://jy95.github.io/torrent-files-library/manual/listEachTvSerie.html)
* [Detect the category of each file](https://jy95.github.io/torrent-files-library/manual/getCategoryForEachFile.html)
* Filtering purposes :
* [Filter movies based on search parameters](https://jy95.github.io/torrent-files-library/manual/filterMoviesByParameters.html)
* [Filter tv-shown based on search parameters](https://jy95.github.io/torrent-files-library/manual/filterTvSeriesByParameters.html)
* Miscellaneous purposes
* [Create custom playlist(s)](https://jy95.github.io/torrent-files-library/manual/createPlaylist.html)
* ...
Don't hesitate to suggest new features : it is always worthy :)
## Documentation
For more examples and API details, see [API documentation with manual](https://jy95.github.io/torrent-files-library/)
## Installation
For npm users :
```shell
$ npm install --save torrent-files-library
```
for Yarn :
```shell
$ yarn add torrent-files-library
```
## Test
```shell
npm test
```
To generate a test coverage report:
```shell
npm run coverage
```
## Contributing
* If you're unsure if a feature would make a good addition, you can always [create an issue](https://github.com/jy95/torrent-files-library/issues/new) 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.