Working on packaging and related docs

This commit is contained in:
Fabrice Quenneville 2020-12-16 05:28:32 -05:00
parent bd983fe140
commit b3676aeb25
4 changed files with 8 additions and 9 deletions

View File

@ -10,7 +10,7 @@ MediaCurator is a Python command line tool to manage a media database.
The documentation is available on the following [link](https://fabquenneville.github.io/MediaCurator/) The documentation is available on the following [link](https://fabquenneville.github.io/MediaCurator/)
## Usage ## Usage
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] [-print:list,formated,verbose] [-dir/-files:"/mnt/media/",,"/mnt/media2/"] 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] [-print:list,formated,verbose] [-dirs/-files:"/mnt/media/",,"/mnt/media2/"]
> for multiple files or filenames use double comma separated values ",," > for multiple files or filenames use double comma separated values ",,"
@ -22,12 +22,11 @@ default options are:
Examples: Examples:
```bash ```bash
mediacurator list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt mediacurator list -filters:old -print:formated -dirs:/mnt/media/ >> ../medlist.txt
mediacurator convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/" mediacurator convert -del -filters:mpeg4 -out:av1,mp4 -dirs:"/mnt/media/Movies/"
mediacurator convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/ mediacurator convert -del -in:avi,mpg -print:formated,verbose -dirs:/mnt/media/
``` ```
## Contributing ## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

View File

@ -15,4 +15,4 @@ Install from GitHub
.. code-block:: bash .. code-block:: bash
:linenos: :linenos:
pip install mediacurator pip install MediaCurator

View File

@ -43,7 +43,7 @@
</div> </div>
<div class="section" id="install-from-github"> <div class="section" id="install-from-github">
<h2>Install from GitHub<a class="headerlink" href="#install-from-github" title="Permalink to this headline"></a></h2> <h2>Install from GitHub<a class="headerlink" href="#install-from-github" title="Permalink to this headline"></a></h2>
<div class="highlight-bash notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1</pre></div></td><td class="code"><div class="highlight"><pre><span></span>pip install mediacurator <div class="highlight-bash notranslate"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre>1</pre></div></td><td class="code"><div class="highlight"><pre><span></span>pip install MediaCurator
</pre></div> </pre></div>
</td></tr></table></div> </td></tr></table></div>
</div> </div>
@ -84,7 +84,7 @@
</ul> </ul>
<p class="caption"><span class="caption-text">Release Notes:</span></p> <p class="caption"><span class="caption-text">Release Notes:</span></p>
<ul> <ul>
<li class="toctree-l1"><a class="reference internal" href="../releasenotes/0.0.1-changelog.html">mediacurator 0.0.1 Release Notes</a></li> <li class="toctree-l1"><a class="reference internal" href="../releasenotes/0.0.1-changelog.html">MediaCurator 0.0.1 Release Notes</a></li>
</ul> </ul>
<div class="relations"> <div class="relations">

View File

@ -7,7 +7,7 @@ with open("README.md", "r", encoding="utf-8") as fh:
setuptools.setup( setuptools.setup(
name="MediaCurator", name="MediaCurator",
version="0.0.2", version="0.0.3",
author="Fabrice Quenneville", author="Fabrice Quenneville",
author_email="fab@fabq.ca", author_email="fab@fabq.ca",
url="https://github.com/fabquenneville/MediaCurator", url="https://github.com/fabquenneville/MediaCurator",