Fabrice Quenneville
a82e97de75
- Updated installation documentation to include instructions for installing mediacurator via APT repository. - Added a table of contents for easier navigation. - Moved FFmpeg installation instructions to the bottom, noting that they are only required when installing via pip if not already installed.
245 lines
14 KiB
HTML
245 lines
14 KiB
HTML
<!DOCTYPE html>
|
||
|
||
<html lang="en" data-content_root="./">
|
||
<head>
|
||
<meta charset="utf-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
|
||
<title>Welcome to mediacurator’s documentation! — mediacurator documentation</title>
|
||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
|
||
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=12dfc556" />
|
||
<link rel="stylesheet" type="text/css" href="_static/custom.css?v=d9b65b63" />
|
||
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||
<script src="_static/doctools.js?v=9a2dae69"></script>
|
||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||
<link rel="icon" href="_static/favicon.ico"/>
|
||
<link rel="index" title="Index" href="genindex.html" />
|
||
<link rel="search" title="Search" href="search.html" />
|
||
<link rel="next" title="Warnings" href="usage/warnings.html" />
|
||
|
||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||
|
||
|
||
|
||
|
||
|
||
</head><body>
|
||
|
||
|
||
<div class="document">
|
||
<div class="documentwrapper">
|
||
<div class="bodywrapper">
|
||
|
||
|
||
<div class="body" role="main">
|
||
|
||
<section id="welcome-to-mediacurator-s-documentation">
|
||
<h1>Welcome to mediacurator’s documentation!<a class="headerlink" href="#welcome-to-mediacurator-s-documentation" title="Link to this heading">¶</a></h1>
|
||
<p>mediacurator is a Python command line tool to manage a media database.</p>
|
||
<ul class="simple">
|
||
<li><p>List all the videos and their information with or without filters</p></li>
|
||
<li><p>Batch find and repair/convert videos with encoding errors</p></li>
|
||
<li><p>Batch recode videos to more modern codecs (x265 / AV1) based on filters: extensions, codecs, resolutions …</p></li>
|
||
</ul>
|
||
<p>The source code can be found on <a class="reference external" href="https://github.com/fabquenneville/mediacurator">GitHub</a></p>
|
||
<div class="admonition warning">
|
||
<p class="admonition-title">Warning</p>
|
||
<p><strong>Breaking changes in version 1.0.1:</strong></p>
|
||
<p>Starting with version 1.0.1, the command-line interface (CLI) has undergone major changes, and the usage is <strong>not backwards-compatible</strong> with previous versions.</p>
|
||
<p>If you are using <cite>mediacurator < 1.0.1</cite>, please refer to the legacy documentation available below (<a class="reference internal" href="#legacy-docs"><span class="std std-ref">Legacy Documentation (Pre 1.0)</span></a>).</p>
|
||
</div>
|
||
<section id="documentation">
|
||
<h2>Documentation<a class="headerlink" href="#documentation" title="Link to this heading">¶</a></h2>
|
||
<div class="toctree-wrapper compound">
|
||
<p class="caption" role="heading"><span class="caption-text">Usage:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="usage/warnings.html">Warnings</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/warnings.html#example-use-cases-for-the-delete-flag">Example use cases for the <cite>–delete</cite> Flag</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/warnings.html#important-notes">Important Notes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/warnings.html#dry-run-example-without-deletion">Dry run example (without deletion)</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/installation.html#table-of-contents">Table of contents</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/installation.html#about-mediacurator-s-installation">About mediacurator’s installation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/installation.html#install-from-apt-repository">Install from APT Repository</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/installation.html#install-from-pypi">Install from PyPi</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/installation.html#install-ffmpeg">Install FFmpeg</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usage/manual.html">Manual</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#name">Name</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#synopsis">Synopsis</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#description">Description</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#options">Options</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#examples">Examples</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#see-also">See Also</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#glossary">Glossary</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#error-handling">Error Handling</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/manual.html#author">Author</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/use_cases.html#print-information">Print information</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/use_cases.html#purge">Purge</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/use_cases.html#batch-repair-encoding-errors">Batch repair encoding errors</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/use_cases.html#batch-re-encode">Batch re-encode</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/errors.html#repairable-encoding-errors">Repairable Encoding Errors</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/errors.html#ffmpeg-issues">FFmpeg Issues</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="usage/errors.html#other-bugs">Other Bugs</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="toctree-wrapper compound">
|
||
<p class="caption" role="heading"><span class="caption-text">Release Notes:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/1.0.1-changelog.html">mediacurator 1.0.1 Release Notes</a></li>
|
||
</ul>
|
||
</div>
|
||
<hr class="docutils" />
|
||
</section>
|
||
<section id="legacy-documentation-pre-1-0">
|
||
<span id="legacy-docs"></span><h2>Legacy Documentation (Pre 1.0)<a class="headerlink" href="#legacy-documentation-pre-1-0" title="Link to this heading">¶</a></h2>
|
||
<div class="admonition warning">
|
||
<p class="admonition-title">Warning</p>
|
||
<p>The following documentation is for versions prior to 1.0.1. It may contain features and usage instructions that are incompatible with the current version of mediacurator.</p>
|
||
</div>
|
||
<div class="toctree-wrapper compound">
|
||
<p class="caption" role="heading"><span class="caption-text">Legacy Usage:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="legacy_usage/warnings.html">Warnings</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="legacy_usage/installation.html">Installation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="legacy_usage/quickstart.html">Quickstart</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="legacy_usage/manual.html">Manual</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="legacy_usage/use_cases.html">Use cases</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="legacy_usage/errors.html">Errors</a></li>
|
||
</ul>
|
||
</div>
|
||
<div class="toctree-wrapper compound">
|
||
<p class="caption" role="heading"><span class="caption-text">Legacy Release Notes:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.13-changelog.html">MediaCurator 0.0.13 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.12-changelog.html">MediaCurator 0.0.12 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.11-changelog.html">MediaCurator 0.0.11 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.10-changelog.html">MediaCurator 0.0.10 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.9-changelog.html">MediaCurator 0.0.9 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.8-changelog.html">MediaCurator 0.0.8 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.7-changelog.html">MediaCurator 0.0.7 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.6-changelog.html">MediaCurator 0.0.6 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.5-changelog.html">MediaCurator 0.0.5 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.4-changelog.html">MediaCurator 0.0.4 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>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="#">
|
||
<img class="logo" src="_static/mclogo4x.png" alt="Logo of mediacurator"/>
|
||
</a></p>
|
||
<h1 class="logo"><a href="#">mediacurator</a></h1>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3>
|
||
<p class="caption" role="heading"><span class="caption-text">Usage:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="usage/warnings.html">Warnings</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usage/manual.html">Manual</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Release Notes:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/1.0.1-changelog.html">mediacurator 1.0.1 Release Notes</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Legacy Usage:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="legacy_usage/warnings.html">Warnings</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="legacy_usage/installation.html">Installation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="legacy_usage/quickstart.html">Quickstart</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="legacy_usage/manual.html">Manual</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="legacy_usage/use_cases.html">Use cases</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="legacy_usage/errors.html">Errors</a></li>
|
||
</ul>
|
||
<p class="caption" role="heading"><span class="caption-text">Legacy Release Notes:</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.13-changelog.html">MediaCurator 0.0.13 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.12-changelog.html">MediaCurator 0.0.12 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.11-changelog.html">MediaCurator 0.0.11 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.10-changelog.html">MediaCurator 0.0.10 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.9-changelog.html">MediaCurator 0.0.9 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.8-changelog.html">MediaCurator 0.0.8 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.7-changelog.html">MediaCurator 0.0.7 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.6-changelog.html">MediaCurator 0.0.6 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.5-changelog.html">MediaCurator 0.0.5 Release Notes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="releasenotes/0.0.4-changelog.html">MediaCurator 0.0.4 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>
|
||
|
||
<div class="relations">
|
||
<h3>Related Topics</h3>
|
||
<ul>
|
||
<li><a href="#">Documentation overview</a><ul>
|
||
<li>Next: <a href="usage/warnings.html" title="next chapter">Warnings</a></li>
|
||
</ul></li>
|
||
</ul>
|
||
</div>
|
||
<search id="searchbox" style="display: none" role="search">
|
||
<h3 id="searchlabel">Quick search</h3>
|
||
<div class="searchformwrapper">
|
||
<form class="search" action="search.html" method="get">
|
||
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
|
||
<input type="submit" value="Go" />
|
||
</form>
|
||
</div>
|
||
</search>
|
||
<script>document.getElementById('searchbox').style.display = "block"</script>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</div>
|
||
</div>
|
||
<div class="clearer"></div>
|
||
</div>
|
||
<div class="footer">
|
||
©2020, Fabrice Quenneville.
|
||
|
||
|
|
||
Powered by <a href="https://www.sphinx-doc.org/">Sphinx 7.4.7</a>
|
||
& <a href="https://alabaster.readthedocs.io">Alabaster 0.7.16</a>
|
||
|
||
|
|
||
<a href="_sources/index.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |