Install¶

wordlevel runs on Python 3.10 and above. It can be installed with any Python package manager, including pip and uv. If you want to use uv, make sure to install it first.

Create a virtual environment¶

Creating a virtual environment is optional, but it keeps wordlevel and its dependencies separate from other projects on your computer. From the directory where you want to work, run the following commands:

python -m venv .venv
source .venv/bin/activate

uv venv
source .venv/bin/activate

Install wordlevel¶

To install wordlevel, simply run one of the following commands:

pip install wordlevel

uv pip install wordlevel

Saving plots¶

wordlevel uses Altair to generate plots. To save plots as PNGs, SVGs, or PDFs, some extra dependencies are required. Install them with the save extra:

pip install "wordlevel[save]"

uv pip install "wordlevel[save]"

Check that it worked¶

If the following command prints a version number, you are ready to go!

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