Skip to main content

A simple flask webapp to download the audio track from almost any internet video.

Project description

HomePage

HomePage is a trivial flask web app that allows downloading the audio track from almost any internet video. It is intended to be deployed inside a private network for personal use, so that hosts within the network can access and download the tracks they want.

HomePage is very basic, but it has a Material Design front-end which is simple and easy to use. HomePage uses youtube_dl to download the videos, so quite a few sites are supported. Playlists are also supported.

HomePage

Setup & Prerequsites

  • python 3.6 or above
  • The pip module for the above python version
  • sudo access if you wish to use port 80
  • pyenv installed (optional)
  • poetry installed (optional)

The basic installation is very simple.

$ python3 -m pip install --user homepage

# Normal desktop
$ homepage -i

# TTY only server
$ homepage -ic

Then, you can deploy with:

$ homepage -df

Alternatively, if your system is running an older version of python or you wish to run this project inside a virtual environment, you can do that too. In fact, this is the recommended method of installing this project.

First, go ahead and install pyenv. Then install poetry. Once you've installed those, we just to install a few more things.

$ git clone https://github.com/Sh3llcod3/HomePage.git
$ cd HomePage/
$ pyenv install 3.7.4
$ pyenv local 3.7.4
$ poetry self:update --preview || poetry self update --preview
$ poetry update
$ poetry install # Add --no-dev if you don't want to tweak.
$ poetry shell
$ homepage -ip
$ homepage -df

After installing pyenv, the lines you add to your ~/.bashrc may need to be different, please see the FAQ.

Usage

Once deployed, if you're using this on the device which is hosting it, fire up your favourite web browser and head to http://0.0.0.0:5000/. If you're on another device, simply head to the IP address that it prints out when you run it.

If you have sudo access, please use the -f switch. If you don't, other hosts can still use this, but they will need to explicitly specify the port, e.g. http://192.168.0.10:5000.

From there, you just need to select your options and paste in a link to the video or playlist that you want to download the tracks from. Obviously, you can download from YouTube, but thanks to the power of the youtube_dl library, many other sites will also work, e.g. Vimeo, or Reddit. You can find the full list here.

FAQ & Troubleshooting

I'm having trouble with the env

You may have inserted the wrong lines in your ~/.bashrc. The initialization lines shown on the pyenv repo don't work well with poetry. Instead, add these lines to the end of the file and remove any previous lines you may have added before (taking care to ensure you don't remove anything else).

# Pyenv installation

if [[ -z "$VIRTUAL_ENV" ]]; then
    export PATH="$HOME/.pyenv/bin:$PATH"
    eval "$(pyenv init -)"
fi

Can I change the background?

You absolutely can. To change the background, change out homepage/static/Background.jpg with any image you like, but it has to be called Background.jpg and in the JPEG format. I will make this process easier in the future.

Pyenv fails to install 3.7.4

You may have forgotten to install some crucial pyenv dependencies. If you're using other package managers, check here for their wiki page. If you're using apt, you can simply run:

$ sudo apt update
$ sudo apt-get install -y --no-install-recommends make build-essential libssl-dev zlib1g-dev libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev

Then retry the pyenv installation.

Why does HomePage exist?

That is a really good question. I wanted a simple web app where I could download music from various videos on any device, without having access to a command line version of youtube_dl or resorting to using shady sites and apps.

The code is bad at best, but it is functional and you have the freedom of choice. Whether you want to use it or not is up to you, but I assumed that people prefer convenience, so I should probably upload this where more people may be able to take advantage of this.

Why is it not working?

Your version of youtube_dl may be out of date. Having a version of youtube_dl that is even one version old can mean your tracks may fail to download. Fortunately, the library is updated frequently and you can pull in the updates very easily.

If you're using it from PyPi, then:

$ python3 -m pip install --upgrade youtube_dl gevent Flask --user

If you're using it from the env, then simply cd to the directory you installed it and run:

$ poetry update
$ poetry shell

You may want to write some sort of cron job to do this every few days or so.

Does HomePage scale?

No. It was never intended to scale in the first place. Neither is it secure in any way. Therefore, I should stress that you should NOT deploy this to anywhere except your private/internal network.

Does it have Windows support?

No. However I am planning to release compiled executables for both Windows and Linux so stay tuned for that, if you're interested.

Why does it take a long time?

Time is of the essence. I understand that if a specific computational task does not complete as quickly as someone anticipates, it can leave the user feeling disappointed.

However, the length of time it takes for a specific video to be downloaded heavily depends on several factors, such as the length, quantity and chosen quality of the download. On top of this, you have to consider that for each video you download, youtube_dl has to first download the video, then it has to be encoded in your preferred format using ffmpeg. That can take a while, especially on older systems.

I am always looking to optimise this so it downloads and converts the videos faster, but if you have any tips, please create an issue and I'll check it out as soon as possible.

To-do

  • [ ] Add an authentication page.
  • [ ] Make site restore state after a download.
  • [ ] Save user preferences using cookies.
  • [ ] Display past tracks only for that host.
  • [ ] Add a separate page for management.
  • [ ] Create a system to auto-update youtube_dl
  • [ ] Make it work on windows and generate executables

Project details


Download files

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

Files for homepage, version 0.3.6
Filename, size File type Python version Upload date Hashes
Filename, size homepage-0.3.6-py3-none-any.whl (434.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size homepage-0.3.6.tar.gz (435.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page