From b6ce978c87721d83d6fb9b79272935bf0e6b56da Mon Sep 17 00:00:00 2001 From: Fabrice Quenneville Date: Tue, 15 Dec 2020 23:40:31 -0500 Subject: [PATCH] Working on docs/packaging --- .gitignore | 15 +++++++- docs/_sources/usage/manual.rst.txt | 8 ++--- docs/_sources/usage/quickstart.rst.txt | 8 ++--- docs/_sources/usage/use_cases.rst.txt | 22 ++++++------ docs/_sources/usage/warnings.rst.txt | 10 +++--- docs/searchindex.js | 2 +- docs/usage/manual.html | 8 ++--- docs/usage/quickstart.html | 8 ++--- docs/usage/use_cases.html | 22 ++++++------ docs/usage/warnings.html | 10 +++--- docsource/build/doctrees/environment.pickle | Bin 25510 -> 25372 bytes docsource/build/doctrees/usage/manual.doctree | Bin 24858 -> 24898 bytes .../build/doctrees/usage/quickstart.doctree | Bin 5421 -> 5461 bytes .../build/doctrees/usage/use_cases.doctree | Bin 19538 -> 19648 bytes .../build/doctrees/usage/warnings.doctree | Bin 6013 -> 6063 bytes .../build/html/_sources/usage/manual.rst.txt | 8 ++--- .../html/_sources/usage/quickstart.rst.txt | 8 ++--- .../html/_sources/usage/use_cases.rst.txt | 22 ++++++------ .../html/_sources/usage/warnings.rst.txt | 10 +++--- docsource/build/html/searchindex.js | 2 +- docsource/build/html/usage/manual.html | 8 ++--- docsource/build/html/usage/quickstart.html | 8 ++--- docsource/build/html/usage/use_cases.html | 22 ++++++------ docsource/build/html/usage/warnings.html | 10 +++--- mediacurator/__init__.py | 2 +- setup.py | 32 ++++++++++++++++++ 26 files changed, 145 insertions(+), 100 deletions(-) create mode 100644 setup.py diff --git a/.gitignore b/.gitignore index f91197c..7d8a9b1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,17 @@ **/__pycache__ test.sh renamelist.txt -.vscode \ No newline at end of file +.vscode + +# Docs build data +/docsource/build/ +/docsource/source/_* + +# Compiled python modules. +*.pyc + +# Setuptools distribution folder. +/dist/ + +# Python egg metadata, regenerated from source files by setuptools. +/*.egg-info \ No newline at end of file diff --git a/docs/_sources/usage/manual.rst.txt b/docs/_sources/usage/manual.rst.txt index 7b94d35..c85fd29 100644 --- a/docs/_sources/usage/manual.rst.txt +++ b/docs/_sources/usage/manual.rst.txt @@ -12,7 +12,7 @@ Synopsis .. code-block:: bash - ./curator.py [list,convert] [-del] + ./mediacurator.py [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 - ./curator.py list -filters:old -print:formated -dirs:/mnt/media/ >> ../medlist.txt + ./mediacurator.py 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 - ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/" + ./mediacurator.py 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 - ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/ + ./mediacurator.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/ More examples in :doc:`use_cases` diff --git a/docs/_sources/usage/quickstart.rst.txt b/docs/_sources/usage/quickstart.rst.txt index 74403b4..ed6bc70 100644 --- a/docs/_sources/usage/quickstart.rst.txt +++ b/docs/_sources/usage/quickstart.rst.txt @@ -4,7 +4,7 @@ Quickstart .. code-block:: bash - ./curator.py [list,convert] [-del] + ./mediacurator.py [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 - ./curator.py list -filters:old -print:formated -dirs:/mnt/media/ >> ../medlist.txt + ./mediacurator.py 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 - ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/" + ./mediacurator.py 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 - ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/ + ./mediacurator.py 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/docs/_sources/usage/use_cases.rst.txt b/docs/_sources/usage/use_cases.rst.txt index 657e164..319d7c0 100644 --- a/docs/_sources/usage/use_cases.rst.txt +++ b/docs/_sources/usage/use_cases.rst.txt @@ -21,13 +21,13 @@ List all videos with old codec in formated format .. code-block:: bash - ./curator.py list -filters:old -dirs:/mnt/media/ + ./mediacurator.py list -filters:old -dirs:/mnt/media/ List all videos with substandard definitions with a formated output .. code-block:: bash - ./curator.py list -filters:subsd -print:formated -dirs:/mnt/media/ + ./mediacurator.py 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 - ./curator.py list -del -in:avi -dirs:/mnt/media/ + ./mediacurator.py list -del -in:avi -dirs:/mnt/media/ List and delete any videos with encoding errors .. code-block:: bash - ./curator.py list -del -filters:fferror -dirs:/mnt/media/ + ./mediacurator.py list -del -filters:fferror -dirs:/mnt/media/ @@ -66,19 +66,19 @@ List all videos with encoding errors .. code-block:: bash - ./curator.py list -filters:fferror -dirs:/mnt/media/ + ./mediacurator.py list -filters:fferror -dirs:/mnt/media/ List and delete any videos with encoding errors .. code-block:: bash - ./curator.py list -del -filters:fferror -dirs:/mnt/media/ + ./mediacurator.py 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 - ./curator.py convert -del -filters:fferror -dirs:"/mnt/media/Movies/" + ./mediacurator.py convert -del -filters:fferror -dirs:"/mnt/media/Movies/" .. _convert: @@ -90,16 +90,16 @@ Convert all videos with old codecs to `High Efficiency Video Coding

Synopsis

-
./curator.py [list,convert] [-del]
+
./mediacurator.py [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]
@@ -145,11 +145,11 @@
 

Examples

# List all videos with old codec in formated format
-./curator.py list -filters:old -print:formated -dirs:/mnt/media/ >> ../medlist.txt
+./mediacurator.py 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
-./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/"
+./mediacurator.py 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
-./curator.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
+./mediacurator.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
 

More examples in Use cases

diff --git a/docs/usage/quickstart.html b/docs/usage/quickstart.html index 64a1a85..6cb8944 100644 --- a/docs/usage/quickstart.html +++ b/docs/usage/quickstart.html @@ -36,7 +36,7 @@

Quickstart

-
./curator.py [list,convert] [-del]
+
./mediacurator.py [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]
@@ -54,11 +54,11 @@
 

Examples:

# List all videos with old codec in formated format
-./curator.py list -filters:old -print:formated -dirs:/mnt/media/ >> ../medlist.txt
+./mediacurator.py 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
-./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/"
+./mediacurator.py 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
-./curator.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
+./mediacurator.py convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
 

More examples in Use cases

diff --git a/docs/usage/use_cases.html b/docs/usage/use_cases.html index 7206346..118ce79 100644 --- a/docs/usage/use_cases.html +++ b/docs/usage/use_cases.html @@ -54,11 +54,11 @@