Fabrice Quenneville
5ba0f84d12
This release introduces a major overhaul of the `mediacurator` command-line interface (CLI) and comprehensive updates to the documentation. The CLI has transitioned from a custom argument parsing system to utilizing Python's `argparse` and `argcomplete` libraries, greatly enhancing usability and flexibility. Due to these significant changes, the version is incremented from **0.0.13** to **1.0.1**. - **Refactored** `tools.py` for standardized command-line argument handling using `argparse` and `argcomplete`. - **Improved** user interaction with structured arguments and built-in help, error handling, and validation. - **Consolidated** video detail printing logic into a reusable method within the `Video` class. - **Enhanced** `MediaLibrary` class with better clarity, functionality, and expanded support for video formats. - **Reorganized** `main.py` to streamline argument handling and improve error feedback. - **Updated** `setup.py` for release preparation, including new classifiers and dependencies. - **Revised** README.md for clarity, including structured command usage and improved descriptions. - **Moved** and improved old documentation, removing outdated content and adding new screenshots. - **Maintained** legacy commands for backward compatibility while enhancing usability with clear examples. - **Removed** non-existent `bcolors` from the public API. - **Upgraded** requirements.txt to include `argcomplete` for command-line completion. - **Updated** docstrings and function documentation for clarity on functionality and parameters.
40 lines
1.3 KiB
ReStructuredText
40 lines
1.3 KiB
ReStructuredText
==========
|
|
Quickstart
|
|
==========
|
|
|
|
.. warning::
|
|
|
|
The following documentation is for versions prior to 1.0.1. It may contain features and usage instructions that are incompatible with the current version of mediacurator.
|
|
|
|
.. code-block:: bash
|
|
|
|
mediacurator [list,convert] [-del]
|
|
[-in:any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid,divx,ogm,webm]
|
|
[-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:
|
|
|
|
.. code-block:: bash
|
|
|
|
-in:any
|
|
-filters:
|
|
-out:mkv,x265
|
|
-print:list
|
|
|
|
Examples:
|
|
|
|
.. code-block:: bash
|
|
|
|
# List all videos with old codec in formated format
|
|
mediacurator list -filters:old -print:formated -dirs:/mnt/media/ >> ../medlist.txt
|
|
# Convert all videos with the codec mpeg4 in a mp4 using the av1 video codec and the delete the originals
|
|
mediacurator convert -del -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/"
|
|
# Convert any video with avi or mpg extensions, print formated text including ffmpeg's output and then delete the originals
|
|
mediacurator convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
|
|
|
|
More examples in :doc:`use_cases` |