Metadata-Version: 2.1
Name: dl-plus
Version: 0.5.0
Summary: A youtube-dl extension with pluggable extractors
Home-page: https://github.com/un-def/dl-plus
Author: un.def
Author-email: me@undef.im
License: MIT
Project-URL: Source, https://github.com/un-def/dl-plus
Project-URL: Changelog, https://github.com/un-def/dl-plus/blob/master/CHANGELOG.md
Project-URL: Issues, https://github.com/un-def/dl-plus/issues
Description: # dl-plus
        
        A [youtube-dl][youtube-dl-website] extension with pluggable extractors
        
        ## Description
        
        `dl-plus` is an extension and a drop-in replacement of `youtube-dl`. The main goal of the project is to add an easy-to-use extractor plugin system to `youtube-dl` while maintaining full backward compatibility.
        
        `dl-plus` is not a fork of `youtube-dl` and does not contain code from `youtube-dl`, it is a pure dynamic wrapper (thanks to Python dynamic nature) hacking some `youtube-dl` internals.
        
        ## Installation
        
        1.  Install `dl-plus`:
        
            * using [pipx][pipx-website]:
        
              ```
              pipx install dl-plus
              ```
        
            * using pip:
        
              ```
              pip install dl-plus
              ```
        
        2.  Install `youtube-dl` or any compatible package (fork):
        
            * using `dl-plus` itself:
        
              ```
              dl-plus --cmd backend install
              ```
        
            * using [pipx][pipx-website]:
        
              ```
              pipx inject dl-plus youtube-dl
              ```
        
            * using pip:
        
              ```
              pip install youtube-dl
              ```
        
            **NOTE**: if you use a fork where an import path was changed (it is `youtube_dl` by default), you'll need to configure a backend using the config file or the `--backend` command line option.
        
        3.  (optional) Install some plugins:
        
            * using `dl-plus` itself:
        
              ```
              dl-plus --cmd extractor install un1def/wasdtv
              ```
        
              PyPI package names are supported too:
        
              ```
              dl-plus --cmd extractor install dl-plus-extractor-un1def-wasdtv
              ```
        
            * using [pipx][pipx-website]:
        
              ```
              pipx inject dl-plus dl-plus-extractor-un1def-wasdtv
              ```
        
            * using pip:
        
              ```
              pip install dl-plus-extractor-un1def-wasdtv
              ```
        
        4.  (optional) Create `dl-plus` → `youtube-dl` symlink (for apps relying on `youtube-dl` executable in `PATH`, e.g., [mpv][mpv-website]):
        
            - **\*nix**:
        
              ```shell
              dlp=$(command -v dl-plus 2>&1) && ln -s "$dlp" "$(dirname "$dlp")/youtube-dl"
              ```
        
              Use `ln -sf` instead of `ln -s` to overwrite an existing `youtube-dl` executable.
        
            - **Windows** (PowerShell, requires administrative privileges):
        
              ```powershell
              $dlp = (Get-Command -ErrorAction:Stop dl-plus).Path; New-Item -ItemType SymbolicLink -Path ((Get-Item $dlp).Directory.FullName + "\youtube-dl.exe") -Target $dlp
              ```
        
        ## Extractor Plugin Authoring Guide
        
        See [docs/extractor-plugin-authoring-guide.md](https://github.com/un-def/dl-plus/blob/master/docs/extractor-plugin-authoring-guide.md).
        
        ## Available Extractor Plugins
        
        See [docs/available-extractor-plugins.md](https://github.com/un-def/dl-plus/blob/master/docs/available-extractor-plugins.md).
        
        ## License
        
        The [MIT License][license].
        
        
        [youtube-dl-website]: https://youtube-dl.org/
        [pipx-website]: https://pipxproject.github.io/pipx/
        [mpv-website]: https://mpv.io/
        [license]: https://github.com/un-def/dl-plus/blob/master/LICENSE
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.6
Description-Content-Type: text/markdown
