diff --git a/README.md b/README.md index 417420a..8dda3d7 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,9 @@ 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 ... -## Installation +## Documentation -This package (For now) will only work on GNU/Linux and requires FFMPEG installed. For now it will be distributed on [GitHub](https://github.com/fabquenneville/MediaCurator.git) - -Installation: -```bash -git clone https://github.com/fabquenneville/MediaCurator.git -cd MediaCurator -pip install -r requirements.txt - -``` +The documentation is available [here](https://fabquenneville.github.io/MediaCurator/) ## Usage ./curator.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] [-print:list,formated,verbose] [-dir/-files:"/mnt/media/",,"/mnt/media2/"] diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt index 733d5da..da395c4 100644 --- a/docs/_sources/index.rst.txt +++ b/docs/_sources/index.rst.txt @@ -2,25 +2,31 @@ sphinx-quickstart on Fri Nov 20 22:46:06 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. - + ======================================== Welcome to MediaCurator's documentation! ======================================== +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 ... + +The source code can be found on `GitHub `_ + .. toctree:: :maxdepth: 2 :caption: Contents: usage/installation - usage/quickstart usage/use_cases usage/errors -Indices and tables -================== +.. Indices and tables +.. ================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +.. * :ref:`genindex` +.. * :ref:`modindex` +.. * :ref:`search` diff --git a/docs/genindex.html b/docs/genindex.html index d22fdb9..3fd2102 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -62,7 +62,6 @@

Contents:

diff --git a/docs/index.html b/docs/index.html index ddd2802..198ffe1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -35,6 +35,12 @@

Welcome to MediaCurator’s documentation!

+

MediaCurator is a Python command line tool to manage a media database.

+ +

The source code can be found on GitHub

Contents:

-
  • Quickstart
  • Use cases
  • Errors
    • -
    -

    Indices and tables

    - -
    @@ -81,7 +78,6 @@

    Contents:

    diff --git a/docs/objects.inv b/docs/objects.inv index 6dc8c73..06bd2a3 100644 Binary files a/docs/objects.inv and b/docs/objects.inv differ diff --git a/docs/search.html b/docs/search.html index cb71970..2984384 100644 --- a/docs/search.html +++ b/docs/search.html @@ -81,7 +81,6 @@

    Contents:

    diff --git a/docs/searchindex.js b/docs/searchindex.js index 77e6e58..d50283d 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/quickstart","usage/use_cases"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/quickstart.rst","usage/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":0,"while":1,For:2,Use:0,audio:1,bash:[],big:1,big_valu:1,chapter:1,clone:2,code:[],com:2,content:0,damag:1,decod:1,distribut:2,download:2,error:0,fabquennevil:2,ffmpeg:0,found:1,frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:0,instal:0,linux:2,mediacur:2,miss:1,modul:0,mpeg:1,now:2,onli:2,packag:2,page:0,pip:2,quickstart:0,referenc:1,requir:2,search:0,sei:1,sourc:[],thi:2,too:1,track:1,txt:2,type:1,work:2},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Quickstart","Use cases"],titleterms:{"case":4,Use:4,document:0,error:1,ffmpeg:2,from:2,github:2,indic:0,instal:2,mediacur:0,quickstart:3,tabl:0,welcom:0}}) \ No newline at end of file +Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/use_cases"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":0,"while":1,For:2,The:0,Use:0,all:0,audio:1,av1:0,base:0,bash:[],batch:0,big:1,big_valu:1,can:0,chapter:1,clone:2,code:0,codec:0,com:2,command:0,content:0,damag:1,databas:0,decod:1,distribut:2,download:2,error:0,extent:0,fabquennevil:2,ffmpeg:0,filter:0,found:[0,1],frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:[],instal:0,line:0,linux:2,list:0,manag:0,media:0,mediacur:2,miss:1,modern:0,modul:[],more:0,mpeg:1,now:2,onli:2,packag:2,page:[],pip:2,python:0,quickstart:[],recod:0,referenc:1,requir:2,search:[],sei:1,sourc:0,thi:2,too:1,tool:0,track:1,txt:2,type:1,video:0,without:0,work:2,x265:0},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Use cases"],titleterms:{"case":3,Use:3,document:0,error:1,ffmpeg:2,from:2,github:2,indic:[],instal:2,mediacur:0,quickstart:[],tabl:[],welcom:0}}) \ No newline at end of file diff --git a/docsource/build/doctrees/environment.pickle b/docsource/build/doctrees/environment.pickle index bf8fdba..bc0d8d9 100644 Binary files a/docsource/build/doctrees/environment.pickle and b/docsource/build/doctrees/environment.pickle differ diff --git a/docsource/build/doctrees/index.doctree b/docsource/build/doctrees/index.doctree index 8265f79..dda39e4 100644 Binary files a/docsource/build/doctrees/index.doctree and b/docsource/build/doctrees/index.doctree differ diff --git a/docsource/build/html/_sources/index.rst.txt b/docsource/build/html/_sources/index.rst.txt index 733d5da..da395c4 100644 --- a/docsource/build/html/_sources/index.rst.txt +++ b/docsource/build/html/_sources/index.rst.txt @@ -2,25 +2,31 @@ sphinx-quickstart on Fri Nov 20 22:46:06 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. - + ======================================== Welcome to MediaCurator's documentation! ======================================== +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 ... + +The source code can be found on `GitHub `_ + .. toctree:: :maxdepth: 2 :caption: Contents: usage/installation - usage/quickstart usage/use_cases usage/errors -Indices and tables -================== +.. Indices and tables +.. ================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +.. * :ref:`genindex` +.. * :ref:`modindex` +.. * :ref:`search` diff --git a/docsource/build/html/genindex.html b/docsource/build/html/genindex.html index d22fdb9..3fd2102 100644 --- a/docsource/build/html/genindex.html +++ b/docsource/build/html/genindex.html @@ -62,7 +62,6 @@

    Contents:

    diff --git a/docsource/build/html/index.html b/docsource/build/html/index.html index ddd2802..198ffe1 100644 --- a/docsource/build/html/index.html +++ b/docsource/build/html/index.html @@ -35,6 +35,12 @@

    Welcome to MediaCurator’s documentation!

    +

    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 …

      • +
    +

    The source code can be found on GitHub

    Contents:

    -
  • Quickstart
  • Use cases
  • Errors
    • -
    -

    Indices and tables

    - -
    @@ -81,7 +78,6 @@

    Contents:

    diff --git a/docsource/build/html/objects.inv b/docsource/build/html/objects.inv index 6dc8c73..06bd2a3 100644 Binary files a/docsource/build/html/objects.inv and b/docsource/build/html/objects.inv differ diff --git a/docsource/build/html/search.html b/docsource/build/html/search.html index cb71970..2984384 100644 --- a/docsource/build/html/search.html +++ b/docsource/build/html/search.html @@ -81,7 +81,6 @@

    Contents:

    diff --git a/docsource/build/html/searchindex.js b/docsource/build/html/searchindex.js index 77e6e58..d50283d 100644 --- a/docsource/build/html/searchindex.js +++ b/docsource/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/quickstart","usage/use_cases"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/quickstart.rst","usage/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":0,"while":1,For:2,Use:0,audio:1,bash:[],big:1,big_valu:1,chapter:1,clone:2,code:[],com:2,content:0,damag:1,decod:1,distribut:2,download:2,error:0,fabquennevil:2,ffmpeg:0,found:1,frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:0,instal:0,linux:2,mediacur:2,miss:1,modul:0,mpeg:1,now:2,onli:2,packag:2,page:0,pip:2,quickstart:0,referenc:1,requir:2,search:0,sei:1,sourc:[],thi:2,too:1,track:1,txt:2,type:1,work:2},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Quickstart","Use cases"],titleterms:{"case":4,Use:4,document:0,error:1,ffmpeg:2,from:2,github:2,indic:0,instal:2,mediacur:0,quickstart:3,tabl:0,welcom:0}}) \ No newline at end of file +Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/use_cases"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":0,"while":1,For:2,The:0,Use:0,all:0,audio:1,av1:0,base:0,bash:[],batch:0,big:1,big_valu:1,can:0,chapter:1,clone:2,code:0,codec:0,com:2,command:0,content:0,damag:1,databas:0,decod:1,distribut:2,download:2,error:0,extent:0,fabquennevil:2,ffmpeg:0,filter:0,found:[0,1],frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:[],instal:0,line:0,linux:2,list:0,manag:0,media:0,mediacur:2,miss:1,modern:0,modul:[],more:0,mpeg:1,now:2,onli:2,packag:2,page:[],pip:2,python:0,quickstart:[],recod:0,referenc:1,requir:2,search:[],sei:1,sourc:0,thi:2,too:1,tool:0,track:1,txt:2,type:1,video:0,without:0,work:2,x265:0},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Use cases"],titleterms:{"case":3,Use:3,document:0,error:1,ffmpeg:2,from:2,github:2,indic:[],instal:2,mediacur:0,quickstart:[],tabl:[],welcom:0}}) \ No newline at end of file diff --git a/docsource/source/index.rst b/docsource/source/index.rst index 733d5da..da395c4 100644 --- a/docsource/source/index.rst +++ b/docsource/source/index.rst @@ -2,25 +2,31 @@ sphinx-quickstart on Fri Nov 20 22:46:06 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. - + ======================================== Welcome to MediaCurator's documentation! ======================================== +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 ... + +The source code can be found on `GitHub `_ + .. toctree:: :maxdepth: 2 :caption: Contents: usage/installation - usage/quickstart usage/use_cases usage/errors -Indices and tables -================== +.. Indices and tables +.. ================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +.. * :ref:`genindex` +.. * :ref:`modindex` +.. * :ref:`search` diff --git a/docsource/source/usage/quickstart.rst b/docsource/source/usage/quickstart.rst deleted file mode 100644 index f41ce4b..0000000 --- a/docsource/source/usage/quickstart.rst +++ /dev/null @@ -1,4 +0,0 @@ - -========== -Quickstart -========== \ No newline at end of file