Install System Dependencies¶
Install the required (and optional) system dependencies for keyed-extras.
| Dependency | Required for | Installation Priority |
|---|---|---|
| Cairo | Core rendering functionality | Required |
| FFmpeg | Faster video rendering | Recommended |
| Pango | Rich text formatting | Optional |
| librsvg | SVG rendering | Optional |
Choose the method that works best for your system:¶
conda (platform-agnostic)¶
Create an environment.yml file
environment.yml
name: keyed
channels:
- conda-forge
- nodefaults
dependencies:
- python<3.13,>=3.11
- ffmpeg
- cairo
- pycairo
- pango>=1.56.0
- pygobject
- librsvg
- pip
- pip:
- --index-url https://pkgs.keyed.dev/simple
- --extra-index-url https://pypi.org/simple
- keyed-extras[login,previewer]>=0.1.3
Create and activate the environment:
Note
This handles installing both the system dependencies and keyed and keyed-extras, so if you used this approach you're done! Check out the example gallery to get started.
Ubuntu/Debian¶
sudo apt-get update && sudo apt-get install -y \
# Required dependencies
libcairo2-dev \
pkg-config \
python3-dev \
gcc \
# Optional but recommended dependencies
ffmpeg \ # Enables faster ffmpeg-based rendering
libpango1.0-dev \ # Enables the RichText object
librsvg2-dev # Enables the SVG object for rendering SVG files
macOS¶
Fedora¶
Arch Linux¶
Windows (use conda instead)¶
Windows support is entirely untested!
Until wonderful people like you contribute and test more robust installation instructions, I recommend using the conda installation instructions instead.