pybalt 2024.11.10

No project description provided

pybalt

Python module & CLI to download media using cobalt processing instance(s)

CLI Preview

Installation

Install using PowerShell

powershell -Command "Invoke-WebRequest -Uri https://raw.githubusercontent.com/nichind/pybalt/main/install.bat -OutFile install.bat; .\install.bat"

Install using PIP

pip install pybalt

This should create aliases pybalt and cobalt in your shell.

Try running cobalt -h to see the help message.

If for some reason it didn't work, try using it with python:

python -m pybalt

Usage & Examples

Selecting processing instance

You can set processing instance url, api key and user-agent to enviroment variables, pybalt will use them if none was provided.

COBALT_API_URL=YOUR_INSTANCE_URL
COBALT_API_KEY=YOUR_API_KEY
COBALT_USER_AGENT=YOUR_USER_AGENT

By default pybalt uses https://dwnld.nichind.dev as the processing instance. I recommend hosting your own instance or asking someone to give you api key for their instance.

As a CLI

Every command here uses the cobalt alias, you can also use pybalt or python -m pybalt as well.

By default all downloads are saved in a user downloads folder ~/Downloads or the one specified by the --folder flag.

Get list of all available commands by running:

cobalt -h

Download video from URL

cobalt -u 'https://youtube.com/watch?v=8ZP5eqm4JqM'

you can also provide url as positional argument:

cobalt 'https://youtube.com/watch?v=8ZP5eqm4JqM'

Download Youtube playlist

cobalt -pl 'https://youtube.com/playlist?list=PL_93TBqf4ymR9GsuI9W4kQ-G3WM7d2Tqj'

Download from text file

Create a text file with URLs on each line:

https://youtube.com/watch?v=8ZP...
.....
....
...

then run:

cobalt -l 'path/to/file.txt'

More examples

Download all videos from a YouTube playlist in 720p to folder /Music/, filename style classic, use instance https://dwnld.nichind.dev with api key authorization

cobalt -pl 'https://youtube.com/playlist?list=PL_93TBqf4ymR9GsuI9W4kQ-G3WM7d2Tqj' -q 720 -f './Music/' -fs 'classic' -i 'https://dwnld.nichind.dev' -k 'YOUR_API_KEY'

As a module

Download video from URL

from pybalt import Cobalt
from asyncio import run


async def main():
    cobalt = Cobalt()
    path = await cobalt.download('https://youtube.com/watch?v=8ZP5eqm4JqM')
    print('Downloaded: ', path)  # Downloaded: /Users/%USER%/Downloads/8ZP5eqm4JqM.mp4


run(main())

You can pass arguments inside Cobalt object:

from pybalt import Cobalt
from asyncio import run


async def main():
    cobalt = Cobalt(api_instance='YOUR_INSTANCE_URL', api_key='YOUR_API_KEY', headers={...})
    path = await cobalt.download(url='https://youtube.com/watch?v=8ZP5eqm4JqM', quality='1080')
    print('Downloaded: ', path)  # Downloaded: /Users/%USER%/Downloads/8ZP5eqm4JqM.mp4


run(main())

Contributing

If you have any questions or suggestions, please open an issue or create a pull request.

Contributors