From eea92f698ce90a6f270289299f49ceee65d699ef Mon Sep 17 00:00:00 2001 From: Fabrice Quenneville Date: Wed, 16 Dec 2020 03:18:09 -0500 Subject: [PATCH] Working on packaging and related docs --- docsource/source/usage/installation.rst | 4 +--- docsource/source/usage/manual.rst | 8 ++++---- docsource/source/usage/quickstart.rst | 8 ++++---- docsource/source/usage/use_cases.rst | 22 +++++++++++----------- docsource/source/usage/warnings.rst | 10 +++++----- 5 files changed, 25 insertions(+), 27 deletions(-) diff --git a/docsource/source/usage/installation.rst b/docsource/source/usage/installation.rst index 0458a04..022d84c 100644 --- a/docsource/source/usage/installation.rst +++ b/docsource/source/usage/installation.rst @@ -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 diff --git a/docsource/source/usage/manual.rst b/docsource/source/usage/manual.rst index c85fd29..8956006 100644 --- a/docsource/source/usage/manual.rst +++ b/docsource/source/usage/manual.rst @@ -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` diff --git a/docsource/source/usage/quickstart.rst b/docsource/source/usage/quickstart.rst index ed6bc70..cc21b31 100644 --- a/docsource/source/usage/quickstart.rst +++ b/docsource/source/usage/quickstart.rst @@ -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` \ No newline at end of file diff --git a/docsource/source/usage/use_cases.rst b/docsource/source/usage/use_cases.rst index 319d7c0..b85b974 100644 --- a/docsource/source/usage/use_cases.rst +++ b/docsource/source/usage/use_cases.rst @@ -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 `_ .. 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 `_ 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