https://github.com/feedzai/feedzai-altair-theme

Feedzai's theme for Altair charts.
https://github.com/feedzai/feedzai-altair-theme

altair altair-themes data-visualization python

Last synced: about 2 months ago
JSON representation

Feedzai's theme for Altair charts.

• Host: GitHub
• URL: https://github.com/feedzai/feedzai-altair-theme
• Owner: feedzai
• License: other
• Created: 2022-04-14T07:48:37.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-02-28T11:40:02.000Z (almost 2 years ago)
• Last Synced: 2024-10-06T14:48:22.658Z (4 months ago)
• Topics: altair, altair-themes, data-visualization, python
• Language: Python
• Homepage: https://pypi.org/project/feedzai-altair-theme/
• Size: 101 KB
• Stars: 14
• Watchers: 7
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# feedzai-altair-theme 

[![PyPI](https://img.shields.io/pypi/v/feedzai-altair-theme)](https://pypi.org/project/feedzai-altair-theme/) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/feedzai/feedzai-altair-theme/master?labpath=demo.ipynb)

Feedzai's theme for [Altair](https://github.com/altair-viz/altair) charts.

## Sneak peek

![Examples of charts with the feedzai-altair-theme applied](https://raw.githubusercontent.com/feedzai/feedzai-altair-theme/master/assets/header.svg)

## Quickstart

### Installation

Via [pip](https://github.com/pypa/pip):

```bash

pip install feedzai-altair-theme

```

Via [Pipenv](https://pipenv.pypa.io/):

```bash

pipenv install feedzai-altair-theme

```

Via [Poetry](https://python-poetry.org/):

```bash

poetry add feedzai-altair-theme

```

Via [PDM](https://pdm.fming.dev/):

```bash

pdm add feedzai-altair-theme

```

Via [Pyflow](https://github.com/David-OConnor/pyflow):

```bash

pyflow install feedzai-altair-theme

```

### Usage

```python

import altair as alt

alt.themes.enable("feedzai")

```

You can find some example charts in the [`demo.ipynb` notebook](demo.ipynb).

## Development

Create the development environment:

```bash

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`):

```bash

make all

```

To see the changes applied to some example charts, use the [`demo.ipynb` notebook](demo.ipynb):

```bash

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:

```bash

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

```

This command assumes that the feedzai-altair-theme package [dependencies](https://github.com/feedzai/feedzai-altair-theme/blob/master/setup.py#L28) are already installed in your environment. For more information about the additional flags, check the [pip install documentation](https://pip.pypa.io/en/stable/cli/pip_install/).