feedzai-altair-theme

Feedzai's theme for Altair charts.

Sneak peek

Quickstart

Installation

Via pip:

pip install feedzai-altair-theme

Via Pipenv:

pipenv install feedzai-altair-theme

Via Poetry:

poetry add feedzai-altair-theme

Via PDM:

pdm add feedzai-altair-theme

Via uv:

uv add feedzai-altair-theme

Usage

import altair as alt

alt.theme.enable("feedzai")

You can find some example charts in the demo.ipynb notebook.

Development

Assuming uv is installed, install Python:

uv python install

Create and activate the development environment:

uv sync

source .venv/bin/activate

After implementing changes, type-check with mypy, then lint and format the code with Ruff:

mypy

ruff check --fix

ruff format

To see the changes applied to some example charts, use the demo.ipynb notebook:

jupyter lab demo.ipynb

Once done, run the tests to confirm that the theme is working for the major supported versions of Altair:

uv run --isolated --with "altair==5.5.0" pytest

uv run --isolated --with "altair==6.0.0" pytest

Finally, deactivate the development environment:

deactivate

GitHub Actions

The feedzai-altair-theme is published via GitHub Actions. So, zizmor is used to lint workflows and pinact to pin versions of actions like actions/checkout.

If you change the release.yml file, install zizmor (if necessary), run the following command, and implement the relevant feedback:

zizmor .

To update action versions, install pinact (if necessary) and run the following command:

pinact run -u --min-age 7

Deployment

Bump the package version

Bump the feedzai-altair-theme version using one of the following commands, according to the Semantic Versioning specification:

uv version --bump patch

uv version --bump minor

uv version --bump major

Next, confirm you can build the package locally:

uv build

Open a PR

Once the changes are finished and the feedzai-altair-theme version is updated, open a PR. After the PR is merged, a maintainer will ensure a new package version is released.

Release the new package version

To release a new version of feedzai-altair-theme, create a new (lightweight) tag from the master branch, and a GitHub Actions workflow will take care of the rest:

git tag "v$(uv version --short)"

git tag -n

git push origin --tags

Misc

Install the feedzai-altair-theme package in an environment without an Internet connection

Via repo

First, download the repo and move it to your environment. Then install the package with pip (or an equivalent) by pointing to the folder path and adding the necessary flags:

pip install feedzai-altair-theme/ --no-deps --no-build-isolation

This command assumes that the feedzai-altair-theme dependencies and the uv build backend are already installed in your environment. For more information about the additional flags, check the pip install documentation.

Via wheel

First, download the wheel (a.k.a. built distribution) and move it to your environment. Then install the package with pip (or an equivalent) by pointing to the file path and adding the necessary flags after replacing <VERSION>:

pip install feedzai_altair_theme-<VERSION>-py3-none-any.whl

This command assumes that the feedzai-altair-theme dependencies are already installed in your environment.