README.md

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 Pyflow:

pyflow install feedzai-altair-theme

Usage

import altair as alt

alt.themes.enable("feedzai")

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

Development

Create the development environment:

make init

After implementing changes, run the command to check the types and to format and lint the code (you can also use the individual commands defined in the Makefile):

make all

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

make demo

Misc

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

First, download the repo and move its root folder to your environment. From there, you can install the package with pip by pointing to the folder path and adding some extra flags:

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

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