kenzuya/unshackle
1
0
Fork 2
mirror of https://github.com/unshackle-dl/unshackle.git synced 2026-11-14 04:55:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Deployed 8d3785b with MkDocs version: 1.6.1

Browse Source
This commit is contained in:
2026-08-08 20:05:07 +00:00
parent e8cf049fac
commit 2408d0381a
9 changed files with 177 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dev/rest-api/endpoints/index.html
+1 -1
View File
@@ -3631,7 +3631,7 @@ is unaffected. See <a href="../../creating-a-service/#split-episodes">Split epis
<td><code>enrich</code></td>
<td>boolean</td>
<td><code>false</code></td>
<td>Override title/year from external source.</td>
<td>Override title/year from external source, and fill in the original language.</td>
</tr>
<tr>
<td><code>output_dir</code></td>
guide/cli-reference/index.html
+1 -1
View File
@@ -3180,7 +3180,7 @@ configuration file.</p>
</tr>
<tr>
<td><code>--enrich</code></td>
<td>Override show title/year from the external source. <strong>Requires</strong> one of <code>--tmdb</code>, <code>--imdb</code>, or <code>--animeapi</code>.</td>
<td>Override show title/year from the external source, and fill in the original language. <strong>Requires</strong> one of <code>--tmdb</code>, <code>--imdb</code>, or <code>--animeapi</code>.</td>
</tr>
<tr>
<td><code>--tvdb-order</code></td>
guide/downloading/index.html
+87 -1
View File
@@ -1165,6 +1165,17 @@
<nav class="md-nav" aria-label="Metadata and tagging">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#what-each-metadata-provider-supplies" class="md-nav__link">
<span class="md-ellipsis">
What each metadata provider supplies
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#episode-ordering" class="md-nav__link">
<span class="md-ellipsis">
@@ -2808,6 +2819,17 @@
<nav class="md-nav" aria-label="Metadata and tagging">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#what-each-metadata-provider-supplies" class="md-nav__link">
<span class="md-ellipsis">
What each metadata provider supplies
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#episode-ordering" class="md-nav__link">
<span class="md-ellipsis">
@@ -3621,7 +3643,7 @@ tagging and naming:</p>
<tr>
<td><code>--enrich</code></td>
<td>-</td>
<td>Override the show title and year from an external source. <strong>Requires</strong> one of <code>--tmdb</code>, <code>--imdb</code>, or <code>--animeapi</code>.</td>
<td>Override the show title and year from an external source, and fill in the original language. <strong>Requires</strong> one of <code>--tmdb</code>, <code>--imdb</code>, or <code>--animeapi</code>.</td>
</tr>
<tr>
<td><code>--tvdb-order</code></td>
@@ -3632,6 +3654,70 @@ tagging and naming:</p>
</table>
<div class="language-shell highlight"><span class="filename">Force the right IMDb match and enrich the title</span><pre><span></span><code><span id="__span-30-1"><a id="__codelineno-30-1" name="__codelineno-30-1" href="#__codelineno-30-1"></a>unshackle<span class="w"> </span>dl<span class="w"> </span>--imdb<span class="w"> </span>tt1375666<span class="w"> </span>--enrich<span class="w"> </span>EXAMPLE<span class="w"> </span><span class="m">81234567</span>
</span></code></pre></div>
<h3 id="what-each-metadata-provider-supplies">What each metadata provider supplies<a class="headerlink" href="#what-each-metadata-provider-supplies" title="Permanent link">&para;</a></h3>
<p>Providers differ in what they answer with, so <code>--enrich</code> reads different fields depending on
which ID you gave it. A provider only runs when its key is configured:</p>
<table>
<thead>
<tr>
<th>Provider</th>
<th>Config key</th>
<th>Title and year</th>
<th>Original language</th>
<th>External IDs it returns</th>
</tr>
</thead>
<tbody>
<tr>
<td>TMDB</td>
<td><code>tmdb_api_key</code></td>
<td>yes</td>
<td>yes, alpha-2 such as <code>ko</code></td>
<td>IMDb, TMDB, TVDB</td>
</tr>
<tr>
<td>TVDB</td>
<td><code>tvdb_api_key</code></td>
<td>yes</td>
<td>yes, alpha-3 such as <code>kor</code></td>
<td>TMDB, TVDB, sometimes IMDb</td>
</tr>
<tr>
<td>OMDb</td>
<td><code>omdb_api_key</code></td>
<td>yes</td>
<td>yes, as an English name such as <code>Korean</code></td>
<td>IMDb</td>
</tr>
<tr>
<td>IMDxAPI</td>
<td><code>imdb_api_enabled</code></td>
<td>yes</td>
<td>only when looked up by ID</td>
<td>IMDb</td>
</tr>
<tr>
<td>SIMKL</td>
<td><code>simkl_client_id</code></td>
<td>yes</td>
<td>no, it publishes a country and no language</td>
<td>IMDb, TMDB, TVDB</td>
</tr>
</tbody>
</table>
<p>Whatever the tag looks like, unshackle normalises it before use, so <code>ko</code>, <code>kor</code> and <code>Korean</code>
all end up as the same language.</p>
<p><code>--enrich</code> consults these in a fixed order:</p>
<ul>
<li><code>--tmdb</code> reads TMDB.</li>
<li><code>--imdb</code> tries IMDxAPI, then falls back to OMDb. Since <code>imdb_api_enabled</code> is <code>false</code> by
default, an OMDb key is what makes this path work for most people.</li>
<li><code>--animeapi</code> supplies a title only, so pair it with <code>--tmdb</code> or <code>--imdb</code> if you also want
the year and language.</li>
</ul>
<p>Language is the one field <code>--enrich</code> will not overwrite. A service that already reported an
original language keeps it, because the platform knows its own catalogue better than a
third-party match does. Everything else follows the usual override behaviour.</p>
<h3 id="episode-ordering">Episode ordering<a class="headerlink" href="#episode-ordering" title="Permanent link">&para;</a></h3>
<p>A service does not always number a series the way TVDB's aired order does. Some services list
Futurama in TVDB's <code>alternate</code> (Streaming) order, for example, while TVDB's <code>official</code> order
objects.inv
BIN
View File
Binary file not shown.
reference/api/tracks/index.html
+48
View File
@@ -2141,6 +2141,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Subtitle.strip_webvtt_timestamp_map" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;strip_webvtt_timestamp_map
</span>
</a>
</li>
<li class="md-nav__item">
@@ -3174,6 +3185,17 @@
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#unshackle.core.tracks.Subtitle.strip_webvtt_timestamp_map" class="md-nav__link">
<span class="md-ellipsis">
<code class="doc-symbol doc-symbol-toc doc-symbol-method"></code>&nbsp;strip_webvtt_timestamp_map
</span>
</a>
</li>
<li class="md-nav__item">
@@ -5152,6 +5174,32 @@ explanation list above.</p>
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Subtitle.strip_webvtt_timestamp_map" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">strip_webvtt_timestamp_map</span>
<span class="doc doc-labels">
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
</span>
<a href="#unshackle.core.tracks.Subtitle.strip_webvtt_timestamp_map" class="headerlink" title="Permanent link">&para;</a></h3>
<div class="language-python doc-signature highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nf">strip_webvtt_timestamp_map</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
</span></code></pre></div>
<div class="doc doc-contents ">
<p>Remove X-TIMESTAMP-MAP header lines (RFC 8216 §3.5, HLS only).</p>
<p>Cue times are already absolute, but SubtitleEdit reads the header and offsets
every cue by it during conversion.</p>
</div>
</div>
<div class="doc doc-object doc-function">
<h3 id="unshackle.core.tracks.Subtitle.sanitize_webvtt_timestamps" class="doc doc-heading">
<code class="doc-symbol doc-symbol-heading doc-symbol-method"></code> <span class="doc doc-object-name doc-function-name">sanitize_webvtt_timestamps</span>
reference/configuration/misc/index.html
+3 -1
View File
@@ -2069,7 +2069,9 @@
<h1 id="other-settings">Other Settings<a class="headerlink" href="#other-settings" title="Permanent link">&para;</a></h1>
<p>Smaller configuration areas: external metadata API keys, caching and update checks, logging and debug flags, and deprecated keys.</p>
<h2 id="external-api-keys">External API keys<a class="headerlink" href="#external-api-keys" title="Permanent link">&para;</a></h2>
<p>All are unset by default and enable optional metadata/geolocation features.</p>
<p>All are unset by default and enable optional metadata/geolocation features. For which fields
each metadata provider can actually answer with, see
<a href="../../../guide/downloading/#what-each-metadata-provider-supplies">What each metadata provider supplies</a>.</p>
<table>
<thead>
<tr>
search/search_index.json
+1 -1
View File
File diff suppressed because one or more lines are too long
sitemap.xml
+36 -36
View File
@@ -2,146 +2,146 @@
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
<url>
<loc>https://docs.unshackle.dev/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/creating-a-service/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/service-architecture/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/authentication/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/endpoints/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/errors/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/job-lifecycle/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/quickstart/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/dev/rest-api/remote-sessions/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/configuration-file/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/installation/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/getting-started/quickstart/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/cli-reference/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/downloading/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/drm-and-cdm/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/output-and-naming/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/proxies-and-vpn/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/subtitles/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/troubleshooting/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/guide/vaults/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/config/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/drm/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/service/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/titles/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/api/tracks/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/directories/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/download/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/drm/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/example/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/misc/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/network/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/output/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/services/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
<url>
<loc>https://docs.unshackle.dev/reference/configuration/vaults/</loc>
<lastmod>2026-08-04</lastmod>
<lastmod>2026-08-08</lastmod>
</url>
</urlset>
sitemap.xml.gz
BIN
View File
Binary file not shown.