scdlbot 0.15.0

Telegram Bot for downloading MP3 rips of tracks/sets from SoundCloud, Bandcamp, YouTube with tags and artwork

Telegram Bot for downloading MP3 rips of tracks/sets from SoundCloud, Bandcamp, YouTube with tags and artwork.

• Free software: MIT License

• Documentation: https://scdlbot.readthedocs.io

Contents

• scdlbot Usage in Telegram

  • Supported sites and mainly used packages

• Run your own scdlbot

  • Installation & Configuration

  • Running Locally or at Dedicated Server

  • Deploying to Heroku

  • Deploying to Dokku

scdlbot Usage in Telegram

Send /start or /help command to bot or refer directly to the help message.

Please report all bugs and issues and suggest your improvements to issues.

Supported sites and mainly used packages

scdlbot is standing on the shoulders of giants:

• Telegram Bot API: python-telegram-bot

• SoundCloud: scdl

• Bandcamp: bandcamp-dl

• YouTube, Yandex.Music, Mixcloud, and almost everything from this list: yt-dlp

Run your own scdlbot

Installation & Configuration

Requirements

Those should be available in your PATH:

• Python 3.9+ (pyenv and poetry are recommended)

• FFmpeg 4.0+ if not running on Heroku (fresh builds for Windows, macOS and Linux are recommended)

• Heroku CLI is recommended if you want to deploy to Heroku

Install / Update stable from PyPI (recommended)

pip3 install scdlbot --upgrade

…or get unstable from Git source repository

git clone https://github.com/gpchelkin/scdlbot.git
cd scdlbot
pip3 install --requirement requirements.txt

# Update:
git pull
pip3 install --requirement requirements.txt

Configure Bot

Download or copy configuration file sample and set up config environment variables in it:

# If you've installed from PyPI - download sample config somewhere:
curl -o .env https://raw.githubusercontent.com/gpchelkin/scdlbot/master/.env.sample

# If you've got Git source - just copy sample config:
cp .env.sample .env

# Use your favourite editor. Sample config is self-documented:
nano .env

Telegram Bot Settings

Send the commands from respective filenames in telegram_settings dir to @BotFather, choose your bot and copy corresponding values in order to use the bot conveniently. Disable privacy mode if you want bot to read and check every message in group for links. Otherwise, it would work only for commands.

Running Locally or at Dedicated Server

Using Heroku Local (preferred)

You will need Heroku CLI installed.

# If you've installed from PyPI - download Procfile first (otherwise already present in Git repository):
curl -O https://raw.githubusercontent.com/gpchelkin/scdlbot/master/Procfile

# For long polling mode (when WEBHOOK_ENABLE=0):
heroku local -e .env worker
# For webhook mode (when WEBHOOK_ENABLE=1):
heroku local -e .env web

Using Python only

export $(grep -v '^#' .env | xargs)
python3 -m scdlbot
# or in one line:
env $(grep -v '^#' .env | xargs) python3 -m scdlbot

# If you've installed package from PyPI into the system,
# you can also replace 'python3 -m scdlbot' with only 'scdlbot'

Deploying to Heroku

Register on Heroku, press the button above and configure variables for deploying. When app is deployed you must set only one dyno working on “Resources” tab in your app settings depending on which way of getting updates you have chosen and set in config variables: worker for polling or web for webhook.

Manually

You can do the same as the button above but using Heroku CLI, not as much of a fun. Assuming you are in scdlbot repository directory:

heroku login
# Create app with Python 3 buildpack and set it for upcoming builds:
heroku create --buildpack heroku/python
heroku buildpacks:set heroku/python
# Add FFmpeg buildpack needed for youtube-dl & scdl:
heroku buildpacks:add --index 1 https://github.com/jonathanong/heroku-buildpack-ffmpeg-latest.git --app scdlbot
# Deploy app to Heroku:
git push heroku master
# Set config vars automatically from your local .env file
heroku plugins:install heroku-config
heroku config:push
# Or set them manually:
heroku config:set TG_BOT_TOKEN="<TG_BOT_TOKEN>" STORE_CHAT_ID="<STORE_CHAT_ID>" ...

If you use webhook, start web dyno and stop worker dyno:

heroku ps:scale web=1 worker=0
heroku ps:stop worker

If you use polling, start worker dyno and stop web dyno:

heroku ps:scale worker=1 web=0
heroku ps:stop web

Some useful commands:

# Attach to logs:
heroku logs -t
# Test run ffprobe
heroku run "ffprobe -version"

Deploying to Dokku

Use Dokku (your own Heroku) installed on your own server. App is tested and fully ready for deployment with polling (no webhook yet). https://github.com/dokku/dokku-letsencrypt

export DOKKU=<your_dokku_server>
scp .env $DOKKU:~
ssh $DOKKU
    export DOKKU=<your_dokku_server>
    dokku apps:create scdlbot
    dokku certs:generate scdlbot scdlbot.$DOKKU
    dokku config:set scdlbot $(cat .env | xargs)
    logout
git remote add dokku dokku@$DOKKU:scdlbot
git push dokku master
ssh $DOKKU
    dokku ps:scale scdlbot worker=1 web=0
    dokku ps:restart scdlbot