pymtheg

A Python script to share songs from Spotify/YouTube as a 15 second clip. Designed for use with Termux.

• Installation
• Usage
• Contributing
• License

For Termux users looking for a quick setup script, see Quick Termux Setup.

Installation

pymtheg requires Python 3.6.2 or later, and ffmpeg.

From pip

pip install pymtheg

From main

git clone https://github.com/markjoshwel/pymtheg.git

You can then either use pip to install the dependencies from requirements.txt, or use Poetry instead.

On Termux

Currently, the latest version of rapidfuzz (dependency of spotDL, a core dependency of pymtheg) will fail to build. (maxbachmann/Rapidfuzz#195)

The current solution is to install a slightly older version of the package.

pip install rapidfuzz==1.9.1

Write the following into $HOME/bin/termux-url-opener.

#!/bin/bash

pymtheg $1 -d ~/storage/movies/pymtheg/

Alternatively, you can run the following command to obtain the script:

curl https://raw.githubusercontent.com/markjoshwel/pymtheg/main/termux-url-opener -o $HOME/bin/termux-url-opener

Notes:

• This assumes you have no $HOME/bin/termux-url-opener script. If you do, you may have to tailer the following instructions to work with your current setup.

• This also assumes that you already have a folder named pymtheg in the Movies folder of your internal storage, and that you have already ran termux-setup-storage to allow access of your internal storage from within Termux. If not, simply adjust the script shown above accordingly.

• If you did not install pymtheg through pip, change pymtheg to the path leading to pymtheg.py, such as ~/scripts/pymtheg.py.

• If you have a copy of the repo and use Poetry, change pymtheg to poetry run pymtheg. However do add a line before the pymtheg invocation to change directories to the repository root or else the poetry run invocation will fail.

• Dont forget to chmod +x the script after writing!

Quick Termux Setup

Copy the following command into the terminal:

curl https://raw.githubusercontent.com/markjoshwel/pymtheg/main/termux-pymtheg-setup | sh

Usage

usage: pymtheg [-h] [-d DIR] [-o OUT] [-sda SDARGS] [-ffa FFARGS] [-cl CLIP_LENGTH] [-ud] query

a python script to share songs from Spotify/YouTube as a 15 second clip

positional arguments:
  query                 song/link from spotify/youtube

options:
  -h, --help            show this help message and exit
  -d DIR, --dir DIR     directory to output to
  -o OUT, --out OUT     output file path, overrides directory arg
  -sda SDARGS, --sdargs SDARGS
                        args to pass to spotdl
  -ffa FFARGS, --ffargs FFARGS
                        args to pass to ffmpeg for clip creation
  -cl CLIP_LENGTH, --clip-length CLIP_LENGTH
                        length of output clip in seconds (default 15)
  -ud, --use-defaults   use 0 as clip start and --clip-length as clip end

ffargs default: '-hide_banner -loglevel error -loop 1 -c:a aac -vcodec libx264 -pix_fmt yuv420p -preset ultrafast -tune
stillimage -shortest'

Return Codes

• 0: Successfull
• 1: Invalid args
• 2: Error during song retrieval
• 3: Error during video creation

Contributing

When contributing your first changes, please include an empty commit for copyright waiver using the following message (replace 'John Doe' with your name or nickname):

John Doe Copyright Waiver

I dedicate any and all copyright interest in this software to the
public domain.  I make this dedication for the benefit of the public at
large and to the detriment of my heirs and successors.  I intend this
dedication to be an overt act of relinquishment in perpetuity of all
present and future rights to this software under copyright law.

The command to create an empty commit from the command-line is:

git commit --allow-empty

License

pymtheg is unlicensed with The Unlicense. In short, do whatever. You can find copies of the license in the UNLICENSE file or in the pymtheg module docstring.