Skip to main content

A web version of youtube-dl

Project description

PyPi Package Compatible Python Versions

About

This is a project that builds on pytube 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 pytube’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 current working
    directory or to the value of the YT_DOWNLOAD_PATH environment variable
  • web-youtube-dl-web
    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 image

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

Enhancements

Track progress beyond YT download - tie into ffmpeg - tie into metadata extraction

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

web-youtube-dl-0.3.0.tar.gz (29.7 kB view hashes)

Uploaded source

Built Distribution

web_youtube_dl-0.3.0-py3-none-any.whl (30.3 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page