Installation¶

Requirements¶

Python 3.9 – 3.14
Linux, macOS or Windows

Install¶

pip install darkob

The core install is deliberately small — aiohttp, aiofiles and pycryptodome. Nothing else is required, and no method is lost when the extras are absent.

Optional extras:

pip install "darkob[speed]"   # msgspec: faster JSON on every update
pip install "darkob[cli]"     # rich: styled console banner and prompts

Media metadata (audio duration, image and video dimensions) needs no dependency at all: darkob.utils.media_parser reads the binary headers directly with the standard library. That used to require mutagen plus a temporary file per upload.

Further extras, needed only for specific media features:

pip install "darkob[opencv]"     # video thumbnails via OpenCV
pip install "darkob[movie]"      # video thumbnails via MoviePy
pip install "darkob[pillow]"     # image thumbnails via Pillow
pip install "darkob[aiortc]"     # voice chats
pip install "darkob[pro]"        # everything above

Verify¶

python -c "import darkob; print(darkob.__version__)"

Importing darkob performs no network I/O and prints nothing unless you ask it to.

Development install¶

git clone https://github.com/ManiTheFerfri/darkob.git
cd darkob
pip install -e ".[dev]"

pytest                 # 121 tests, no network required
ruff check .           # lint
pytest --cov=darkob    # coverage

Bot(...) and Messenger(...) print a one-time welcome banner. Disable it when it would pollute logs:

bot = Bot(token="...", show_welcome=False)

Checking for updates¶

Never automatic. Call it yourself if you want a notice:

import darkob
darkob.check_for_updates()   # returns the new version string, or None