diff --git a/README.md b/README.md index ba46c11..2693c6c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # MediaCurator MediaCurator is a Python command line tool to manage a media database. -* List all the video's and their codecs with or without filters -* Batch recode videos to more modern codecs (x265 / AV1) based on filters: extentions, codecs ... +* List all the video’s 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 diff --git a/docs/_sources/usage/manual.rst.txt b/docs/_sources/usage/manual.rst.txt index cb3979f..796951f 100644 --- a/docs/_sources/usage/manual.rst.txt +++ b/docs/_sources/usage/manual.rst.txt @@ -2,6 +2,14 @@ Manual ====== +Name +---- + + MediaCurator + +Synopsis +-------- + .. code-block:: bash ./curator.py [list,convert] [-del] @@ -11,6 +19,48 @@ Manual [-print:list,formated,verbose] [-dir/-files:"/mnt/media/",,"/mnt/media2/"] +Description +----------- + +Options +------- + +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] +-dir: + ["/mnt/media/",,"/mnt/media2/"] +-files: + ["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"] + +Examples +-------- + + +See Also +-------- + +Author +------ + +Fabrice Quenneville + + + + + + **for multiple files or filenames use double comma separated values ",,"** default options are: @@ -29,3 +79,13 @@ Examples: ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/" ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/ + + + +Synopsis + + + +Description + + diff --git a/docs/_sources/usage/quickstart.rst.txt b/docs/_sources/usage/quickstart.rst.txt index 120587c..178a468 100644 --- a/docs/_sources/usage/quickstart.rst.txt +++ b/docs/_sources/usage/quickstart.rst.txt @@ -26,6 +26,10 @@ Examples: .. code-block:: bash + # List all videos with old codec in formated format ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt + # Convert all videos with the codec mpeg4 in a mp4 using the av1 video codec and the delete the originals ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/" ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/ + +More examples in :doc:`use_cases` \ No newline at end of file diff --git a/docs/_sources/usage/use_cases.rst.txt b/docs/_sources/usage/use_cases.rst.txt index 21de4bb..d69455b 100644 --- a/docs/_sources/usage/use_cases.rst.txt +++ b/docs/_sources/usage/use_cases.rst.txt @@ -1,4 +1,3 @@ - ========= Use cases ========= \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index b0bbf4f..39ab4e3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -52,7 +52,16 @@
  • Quickstart
  • -
  • Manual
  • +
  • Manual +
  • Use cases
  • Errors
  • Quickstart
  • -
  • Manual
  • +
  • Manual +
  • Use cases
  • Errors
  • Quickstart
  • -
  • Manual
  • +
  • Manual +
  • Use cases
  • Errors diff --git a/docsource/source/_build/html/usage/quickstart.html b/docsource/source/_build/html/usage/quickstart.html index a26bedb..198e8ea 100644 --- a/docsource/source/_build/html/usage/quickstart.html +++ b/docsource/source/_build/html/usage/quickstart.html @@ -53,11 +53,14 @@

    Examples:

    -
    ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
    +
    # List all videos with old codec in formated format
    +./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt
    +# Convert all videos with the codec mpeg4 in a mp4 using the av1 video codec and the delete the originals
     ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/"
     ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/
     
    +

    More examples in Use cases

    diff --git a/docsource/source/_build/html/usage/use_cases.html b/docsource/source/_build/html/usage/use_cases.html index f73686a..b738d0e 100644 --- a/docsource/source/_build/html/usage/use_cases.html +++ b/docsource/source/_build/html/usage/use_cases.html @@ -17,7 +17,7 @@ - + @@ -60,8 +60,10 @@

    Navigation

    Contents:

    @@ -70,7 +72,7 @@

    Related Topics

    diff --git a/docsource/source/_build/html/usage/warnings.html b/docsource/source/_build/html/usage/warnings.html index a6f27de..f442b0b 100644 --- a/docsource/source/_build/html/usage/warnings.html +++ b/docsource/source/_build/html/usage/warnings.html @@ -38,6 +38,29 @@

    Warnings

    Before using the delete feature please run a few dry runs to get acquainted with MediaCurator as you it can irrirreparably damage your media library when not used properly.

    When using the -del flag here is the expected behavior:

    +

    To delete all non-hd videos in a folder:

    +
    ./curator.py list -del -filters:lowres  -dir/-files:"/mnt/media/"
    +
    +
    +

    To delete all substandard videos in a folder:

    +
    ./curator.py list -del -filters:subsd  -dir/-files:"/mnt/media/"
    +
    +
    +Deleting videos +

    To delete all videos in a folder with encoding errors:

    +
    ./curator.py list -del -filters:fferror  -dir/-files:"/mnt/media/"
    +
    +
    +

    To convert (repair) then delete all videos in a folder with encoding errors:

    +
    ./curator.py convert -del -filters:fferror  -dir/-files:"/mnt/media/"
    +
    +
    +

    To delete all videos in a folder:

    +
    ./curator.py list -del -filters:lowres  -dir/-files:"/mnt/media/"
    +
    +
    +

    All these commands can have valuable use but are irrecoverable if done unintended.

    +

    Again, please run a few dry runs until you are acquainted with MediaCurator.

    diff --git a/docsource/source/usage/manual.rst b/docsource/source/usage/manual.rst index cb3979f..796951f 100644 --- a/docsource/source/usage/manual.rst +++ b/docsource/source/usage/manual.rst @@ -2,6 +2,14 @@ Manual ====== +Name +---- + + MediaCurator + +Synopsis +-------- + .. code-block:: bash ./curator.py [list,convert] [-del] @@ -11,6 +19,48 @@ Manual [-print:list,formated,verbose] [-dir/-files:"/mnt/media/",,"/mnt/media2/"] +Description +----------- + +Options +------- + +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] +-dir: + ["/mnt/media/",,"/mnt/media2/"] +-files: + ["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"] + +Examples +-------- + + +See Also +-------- + +Author +------ + +Fabrice Quenneville + + + + + + **for multiple files or filenames use double comma separated values ",,"** default options are: @@ -29,3 +79,13 @@ Examples: ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/" ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/ + + + +Synopsis + + + +Description + + diff --git a/docsource/source/usage/quickstart.rst b/docsource/source/usage/quickstart.rst index 120587c..178a468 100644 --- a/docsource/source/usage/quickstart.rst +++ b/docsource/source/usage/quickstart.rst @@ -26,6 +26,10 @@ Examples: .. code-block:: bash + # List all videos with old codec in formated format ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt + # Convert all videos with the codec mpeg4 in a mp4 using the av1 video codec and the delete the originals ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/" ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/ + +More examples in :doc:`use_cases` \ No newline at end of file diff --git a/docsource/source/usage/use_cases.rst b/docsource/source/usage/use_cases.rst index 21de4bb..d69455b 100644 --- a/docsource/source/usage/use_cases.rst +++ b/docsource/source/usage/use_cases.rst @@ -1,4 +1,3 @@ - ========= Use cases ========= \ No newline at end of file