web-youtube-dl 0.1.5

A web version of youtube-dl

About

This is a project that builds on youtube-dl to provide a simple web-interface for downloading audio from Youtube. It’s primary purpose is to provide a LAN HTTP accessible method of saving audio to a local device.

This project is built using python’s asyncio libraries and packages include FastAPI, janus, and uvicorn. It’s also an example of how to work with youtube-dl’s python sdk and enable asynchronous downloads in the context of a web-app.

Files are downloaded using an API endpoint and then retrived from the application’s static files directory using Javascript’s fetch API. Download progress is presented via a websocket connection.

Installation

pip install web-youtube-dl

Running

CLI

Installing this project will give you access to two CLI tools, each with a separate purpose:

• web-youtube-dl-cli

  Useful for simply downloading the highest possible quality audio of a song.

  Simply provide the URL and an .mp3 will be downloaded to the package’s

  download directory or to the value of the YT_DOWNLOAD_PATH environment

  variable
• web-youtube-dl

  Useful for running the web service on the local machine. It will

  listen to all local network connections on port 5000 (or whatever port is defined

  in the environment variable YT_DOWNLOAD_PORT).

Docker

This project can optionally be run and managed as a Docker container.

Build the Docker image

docker build . -t  web-youtube-dl:latest --force-rm

Or, using the project’s Makefile

make container

Run the service

When running the service via Docker, you can configure where it stores downloaded songs by default and the port the service listens on by setting the appropriate environment variables.

To configure the port, set the environment variable YT_DOWNLOAD_PORT to some other numerical value.

To configure the download path, set the environment variable YT_DOWNLOAD_PATH to some other filesystem path. Note that an unprivileged user must have access to writing to this location. By default, this is set to tmp and does not really need to be changed.

docker-compose up -d

Or, using the project’s Makefile

make compose

Known Issues

Backend issues if a single user hits submit multiple times.

• “raise RuntimeError(“Response content longer than Content-Length”)”

Should probably build in some websocket Acking during broadcast.