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.
219 lines
11 KiB
HTML
219 lines
11 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>Installation — 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="Quickstart" href="quickstart.html" />
|
||
<link rel="prev" title="Warnings" href="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="installation">
|
||
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h1>
|
||
<section id="table-of-contents">
|
||
<span id="install-toc"></span><h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Link to this heading">¶</a></h2>
|
||
<ul class="simple">
|
||
<li><p><a class="reference internal" href="#install-about"><span class="std std-ref">About mediacurator’s installation</span></a></p></li>
|
||
<li><p><a class="reference internal" href="#install-apt"><span class="std std-ref">Install from APT Repository</span></a></p></li>
|
||
<li><p><a class="reference internal" href="#install-pypi"><span class="std std-ref">Install from PyPi</span></a></p></li>
|
||
<li><p><a class="reference internal" href="#install-ffmpeg"><span class="std std-ref">Install FFmpeg</span></a></p></li>
|
||
</ul>
|
||
</section>
|
||
<section id="about-mediacurator-s-installation">
|
||
<span id="install-about"></span><h2>About mediacurator’s installation<a class="headerlink" href="#about-mediacurator-s-installation" title="Link to this heading">¶</a></h2>
|
||
<p>This package has been tested on GNU/Linux (e.g., Debian, Ubuntu, Fedora) and Windows, and requires FFmpeg to be installed. For now, it will be distributed on <a class="reference external" href="https://github.com/fabquenneville/mediacurator.git">GitHub</a>.</p>
|
||
</section>
|
||
<section id="install-from-apt-repository">
|
||
<span id="install-apt"></span><h2>Install from APT Repository<a class="headerlink" href="#install-from-apt-repository" title="Link to this heading">¶</a></h2>
|
||
<p>The <cite>mediacurator</cite> package is now available through an APT repository. To install it along with all its dependencies (including Python, required Python packages, and FFmpeg) on a Debian/Ubuntu compatible system, follow these steps:</p>
|
||
<ol class="arabic">
|
||
<li><p>Add the APT repository to your system by following the instructions at the <a class="reference external" href="https://debrepo.fabq.ca/">repository homepage</a>.</p></li>
|
||
<li><p>Update your package list:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>update
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
<li><p>Install <cite>mediacurator</cite>:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>mediacurator
|
||
</pre></div>
|
||
</div>
|
||
</li>
|
||
</ol>
|
||
<p>This will automatically install the <cite>mediacurator</cite> package and all its dependencies.</p>
|
||
</section>
|
||
<section id="install-from-pypi">
|
||
<span id="install-pypi"></span><h2>Install from PyPi<a class="headerlink" href="#install-from-pypi" title="Link to this heading">¶</a></h2>
|
||
<p>You can install the <cite>mediacurator</cite> package directly from PyPi using the following command:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>install<span class="w"> </span>mediacurator
|
||
</pre></div>
|
||
</div>
|
||
<p><strong>Note:</strong> If FFmpeg is not already installed, please refer to the instructions in the <a class="reference internal" href="#install-ffmpeg"><span class="std std-ref">Install FFmpeg</span></a> section.</p>
|
||
</section>
|
||
<section id="install-ffmpeg">
|
||
<span id="id1"></span><h2>Install FFmpeg<a class="headerlink" href="#install-ffmpeg" title="Link to this heading">¶</a></h2>
|
||
<p>To install FFmpeg, you can follow the instructions for your platform:</p>
|
||
<ul>
|
||
<li><dl>
|
||
<dt><strong>On Debian and Ubuntu</strong>:</dt><dd><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>update
|
||
sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>ffmpeg
|
||
</pre></div>
|
||
</div>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
<li><dl>
|
||
<dt><strong>On Fedora</strong>:</dt><dd><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>dnf<span class="w"> </span>install<span class="w"> </span>ffmpeg
|
||
</pre></div>
|
||
</div>
|
||
</dd>
|
||
</dl>
|
||
</li>
|
||
<li><p><strong>On Windows</strong>:
|
||
- Download the latest build from <a class="reference external" href="https://ffmpeg.org/download.html">FFmpeg</a>.
|
||
- Follow the installation instructions provided on the site.</p></li>
|
||
</ul>
|
||
<p>To verify your FFmpeg installation, you can run:</p>
|
||
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>ffmpeg<span class="w"> </span>-version
|
||
</pre></div>
|
||
</div>
|
||
</section>
|
||
</section>
|
||
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="sphinxsidebar" role="navigation" aria-label="Main">
|
||
<div class="sphinxsidebarwrapper">
|
||
<p class="logo"><a href="../index.html">
|
||
<img class="logo" src="../_static/mclogo4x.png" alt="Logo of mediacurator"/>
|
||
</a></p>
|
||
<h1 class="logo"><a href="../index.html">mediacurator</a></h1>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h3>Navigation</h3>
|
||
<p class="caption" role="heading"><span class="caption-text">Usage:</span></p>
|
||
<ul class="current">
|
||
<li class="toctree-l1"><a class="reference internal" href="warnings.html">Warnings</a></li>
|
||
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="#table-of-contents">Table of contents</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#about-mediacurator-s-installation">About mediacurator’s installation</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#install-from-apt-repository">Install from APT Repository</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#install-from-pypi">Install from PyPi</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="#install-ffmpeg">Install FFmpeg</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="quickstart.html">Quickstart</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="manual.html">Manual</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="use_cases.html">Use cases</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="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="../index.html">Documentation overview</a><ul>
|
||
<li>Previous: <a href="warnings.html" title="previous chapter">Warnings</a></li>
|
||
<li>Next: <a href="quickstart.html" title="next chapter">Quickstart</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/usage/installation.rst.txt"
|
||
rel="nofollow">Page source</a>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
</body>
|
||
</html> |