Skip to main content

Download mediafiles from YouTube, Twitter (X), Instagram, Reddit & more. CLI wrapper and python module for @imputnet's cobalt processing instance api.

Project description

pybalt

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

GitHub stars Get on pypi Last commit Pip module installs total downloads Ruff

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 tries to parse any avalible instance for you. 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

Contributors

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

pybalt-2024.11.12.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

pybalt-2024.11.12-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file pybalt-2024.11.12.tar.gz.

File metadata

  • Download URL: pybalt-2024.11.12.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pybalt-2024.11.12.tar.gz
Algorithm Hash digest
SHA256 bfe6fe31790272068e60508c515698e68a3d9f5a33e52451cf7bb042f0054115
MD5 791a2d2d79467ac25fee576632005db8
BLAKE2b-256 4fb45651851f200d2a3a6c64fc076f6ab9581edbb46377347b1a6ad383544c63

See more details on using hashes here.

Provenance

The following attestation bundles were made for pybalt-2024.11.12.tar.gz:

Publisher: publish.yml on nichind/pybalt

Attestations:

File details

Details for the file pybalt-2024.11.12-py3-none-any.whl.

File metadata

  • Download URL: pybalt-2024.11.12-py3-none-any.whl
  • Upload date:
  • Size: 11.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for pybalt-2024.11.12-py3-none-any.whl
Algorithm Hash digest
SHA256 6b145a1d0f9e4eaceac5f1b005715285805ca3205f3fca3227b489ad12da30af
MD5 948cefeb642058868c5786388634293b
BLAKE2b-256 dde975930c84f6a931ef6d6a81983e577e6b5ba87032cf0561f149a3501c82d8

See more details on using hashes here.

Provenance

The following attestation bundles were made for pybalt-2024.11.12-py3-none-any.whl:

Publisher: publish.yml on nichind/pybalt

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page