User Install

These instructions for command line usage, such as making sprite sheets or filler assets from fonts.

For other purposes, you should see the following:

If you need to…

…you may want to see:

import fontknife in Python code

Library Install

Contribute fixes or new features

Contributor Setup

Check your Requirements

Fontknife’s Requirements

Make sure you’re in an active virtual environment with Python 3.10 or higher. To learn how, see Install Requirements.

Your Needs

Pick from the table below:

If you need…

…you may want:

Safer Code & Finished Documentation

Planned Releases via PyPI

The Latest Features

The Newest & Buggiest Source

Planned Releases via PyPI

The easiest option is to install the latest stable Fontknife release via pip. This has the following advantages:

  1. The most stable features available

  2. Corresponding doc builds

Installing

Fresh Install

To install Fontknife, run the following commands:

pip install fontknife

Upgrading to the Latest Stable Release

pip install fontknife --upgrade

You can also use the following syntax:

pip install fontknife -U

The Newest & Buggiest Source

To live dangerously, you can install the current main branch directly from GitHub:

pip install https://github.com/pushfoo/Fontknife/archive/main.zip

The unstable main doc is rebuilt automatically each time a commit is pushed to the branch.

Warning

You are currently viewing the stable stable doc.

Please see the unstable main doc if you intend to install from branch source.

You can also specify a commit hash instead of a branch if you want to install a specific commit. For example, the command below will install the commit this doc was built from:

pip install https://github.com/pushfoo/Fontknife/archive/50fa447e23e57ebc4ef94c6882aff4f5a776c990.zip

Warning

There are no doc builds for specific commits!

You’ll be on your own, although you could try to build doc locally.

If you’re getting into specifics like this, you may want to see

  1. Add a requirements.txt somewhere

  2. See In requirements.txt

GitHub Archives Aren’t Deterministic

GitHub’s compression settings and hashes for archive links can change.

If you don’t know what this means, you can probably skip this section. Otherwise, you may want to see the following: