mediacurator/README.md
Fabrice Quenneville 80ef63eccd Rename MediaCurator to mediacurator and update to version 1.0.1
- Breaking change: Renamed the project from 'MediaCurator' to 'mediacurator' to standardize naming conventions (all lowercase).
- Updated all references across documentation and source files:
  - README.md
  - Various .rst documentation files (installation, manual, use cases, errors, warnings)
  - Python source files in 'mediacurator/library' and main 'mediacurator.py'
  - setup.py
- Incremented version from 0.0.13 to 1.0.1 to reflect breaking changes.
- Added release notes for 1.0.1 in docsource/source/releasenotes/1.0.1-changelog.rst
2024-10-17 19:58:25 -04:00

47 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# mediacurator
mediacurator is a Python command line tool to manage a media database.
- List all the videos and their information with or without filters
- Batch find and repair/convert videos with encoding errors
- Batch recode videos to more modern codecs (x265 / AV1) based on filters: extentions, codecs, resolutions …
## Documentation
The documentation is available on the following [link](https://fabquenneville.github.io/mediacurator/)
## Releases
mediacurator is released on [PyPi](https://pypi.org/project/mediacurator/).
Instalation instructions are found on the [Github page](https://fabquenneville.github.io/mediacurator/usage/installation.html).
## Usage
mediacurator [list,convert] [-del] [-in:any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid] [-filters:fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv] [-out:mkv/mp4,x265/av1] [-print:list,formated,verbose] [-dirs/-files:"/mnt/media/",,"/mnt/media2/"]
> for multiple files or filenames use double comma separated values ",,"
default options are:
-in:any
-filters:
-out:mkv,x265
-print:list
Examples:
```bash
mediacurator list -filters:old -print:formated -dirs:/mnt/media/ >> ../medlist.txt
mediacurator convert -del -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/"
mediacurator convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[GNU GPLv3](https://choosealicense.com/licenses/gpl-3.0/)