Skip to content

Quick Install Guide

This guide shows the simplest way to install keyed-extras. For alternative installation methods, see the detailed installation guide.

Step 0: Prerequisites

Before starting, you'll need:

Step 1: Authenticate

Set up access to the keyed private package registry:

pipx run keyed-login

Don't have pipx?

Check out the other authentication methods and then come back here.

The keyed-login tool will:

  • Open GitHub in your browser to verify sponsorship
  • Configure your credentials in ~/.netrc
  • Verify access to the package registry
What's happening behind the scenes?

keyed-login uses GitHub's OAuth Device Flow to securely verify your sponsorship status, then stores a token in your .netrc file that allows pip to authenticate with the keyed private package index when downloading packages.

After running keyed-login, you can verify everything is working: 

$ keyed-login verify
If successful, you'll see output like: 
Testing access for user: dougmercer
✅ Package repository access verified
You can install packages with:
  pip install --index-url https://pkgs.keyed.dev/simple/ keyed-extras

This confirms you can successfully authenticate with the keyed-extras package registry.

Step 2: Create Conda Environment

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:

conda env create -f environment.yml
conda activate keyed

Step 3: Verify Installation

Confirm everything is working:

keyed info

You should see output showing:

  • ✅ keyed-extras version
  • ✅ System dependencies (pango, gi, etc.)
  • ✅ Feature availability (e.g., svg, rich_text)

Installation complete!

🎉 You're ready to create animations! To get started, check out: