Working on packaging and related docs

This commit is contained in:
Fabrice Quenneville 2020-12-16 03:18:09 -05:00
parent adc6f3e081
commit eea92f698c
5 changed files with 25 additions and 27 deletions

View File

@ -15,6 +15,4 @@ Install from GitHub
.. code-block:: bash
:linenos:
git clone https://github.com/fabquenneville/MediaCurator.git
cd MediaCurator
pip install -r requirements.txt
pip install mediacurator

View File

@ -12,7 +12,7 @@ Synopsis
.. code-block:: bash
./mediacurator.py [list,convert] [-del]
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]
@ -128,11 +128,11 @@ Examples
.. code-block:: bash
# List all videos with old codec in formated format
./mediacurator.py list -filters:old -print:formated -dirs:/mnt/media/ >> ../medlist.txt
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.py convert -del -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/"
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.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
mediacurator convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
More examples in :doc:`use_cases`

View File

@ -4,7 +4,7 @@ Quickstart
.. code-block:: bash
./mediacurator.py [list,convert] [-del]
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]
@ -27,10 +27,10 @@ Examples:
.. code-block:: bash
# List all videos with old codec in formated format
./mediacurator.py list -filters:old -print:formated -dirs:/mnt/media/ >> ../medlist.txt
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.py convert -del -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/"
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.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
mediacurator convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
More examples in :doc:`use_cases`

View File

@ -21,13 +21,13 @@ List all videos with old codec in formated format
.. code-block:: bash
./mediacurator.py list -filters:old -dirs:/mnt/media/
mediacurator list -filters:old -dirs:/mnt/media/
List all videos with substandard definitions with a formated output
.. code-block:: bash
./mediacurator.py list -filters:subsd -print:formated -dirs:/mnt/media/
mediacurator list -filters:subsd -print:formated -dirs:/mnt/media/
.. _purge:
@ -41,19 +41,19 @@ List and delete all videos using the `Windows Media Video <https://en.wikipedia.
.. code-block:: bash
./mediacurator.py list -del -filters:wmv -dirs:/mnt/media/
mediacurator list -del -filters:wmv -dirs:/mnt/media/
List and delete all videos using an `Audio Video Interleave <https://en.wikipedia.org/wiki/Audio_Video_Interleave>`_
.. code-block:: bash
./mediacurator.py list -del -in:avi -dirs:/mnt/media/
mediacurator list -del -in:avi -dirs:/mnt/media/
List and delete any videos with encoding errors
.. code-block:: bash
./mediacurator.py list -del -filters:fferror -dirs:/mnt/media/
mediacurator list -del -filters:fferror -dirs:/mnt/media/
@ -66,19 +66,19 @@ List all videos with encoding errors
.. code-block:: bash
./mediacurator.py list -filters:fferror -dirs:/mnt/media/
mediacurator list -filters:fferror -dirs:/mnt/media/
List and delete any videos with encoding errors
.. code-block:: bash
./mediacurator.py list -del -filters:fferror -dirs:/mnt/media/
mediacurator list -del -filters:fferror -dirs:/mnt/media/
Convert all videos with encoding errors to `High Efficiency Video Coding <https://en.wikipedia.org/wiki/High_Efficiency_Video_Coding>`_ and the delete the originals
.. code-block:: bash
./mediacurator.py convert -del -filters:fferror -dirs:"/mnt/media/Movies/"
mediacurator convert -del -filters:fferror -dirs:"/mnt/media/Movies/"
.. _convert:
@ -90,16 +90,16 @@ Convert all videos with old codecs to `High Efficiency Video Coding <https://en.
.. code-block:: bash
./mediacurator.py convert -del -filters:old -dirs:"/mnt/media/Movies/"
mediacurator convert -del -filters:old -dirs:"/mnt/media/Movies/"
Convert all videos with the codec mpeg4 to an mkv container using the av1 video codec
.. code-block:: bash
./mediacurator.py convert -filters:mpeg4 -out:av1,mkv -dirs:"/mnt/media/Movies/"
mediacurator convert -filters:mpeg4 -out:av1,mkv -dirs:"/mnt/media/Movies/"
Convert any video with avi or mpg extensions, print formated text including ffmpeg's output and then delete the originals
.. code-block:: bash
./mediacurator.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
mediacurator convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/

View File

@ -10,13 +10,13 @@ To delete all non-hd videos in a folder:
.. code-block:: bash
./mediacurator.py list -del -filters:lowres -dirs/-files:"/mnt/media/"
mediacurator list -del -filters:lowres -dirs/-files:"/mnt/media/"
To delete all substandard videos in a folder:
.. code-block:: bash
./mediacurator.py list -del -filters:subsd -dirs/-files:"/mnt/media/"
mediacurator list -del -filters:subsd -dirs/-files:"/mnt/media/"
.. image:: ../_static/Screenshot-delete.png
:width: 600
@ -26,19 +26,19 @@ To delete all videos in a folder with encoding errors:
.. code-block:: bash
./mediacurator.py list -del -filters:fferror -dirs/-files:"/mnt/media/"
mediacurator list -del -filters:fferror -dirs/-files:"/mnt/media/"
To convert (repair) then delete all videos in a folder with encoding errors:
.. code-block:: bash
./mediacurator.py convert -del -filters:fferror -dirs/-files:"/mnt/media/"
mediacurator convert -del -filters:fferror -dirs/-files:"/mnt/media/"
To delete all videos in a folder:
.. code-block:: bash
./mediacurator.py list -del -filters:lowres -dirs/-files:"/mnt/media/"
mediacurator list -del -filters:lowres -dirs/-files:"/mnt/media/"
All these commands can have valuable use but are irrecoverable if done unintended.