# feedzai-altair-theme <img align="right" src="https://raw.githubusercontent.com/feedzai/feedzai-altair-theme/master/assets/logo.svg" height="96" />
[![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/).
Raw data
{
"_id": null,
"home_page": "https://github.com/feedzai/feedzai-altair-theme",
"name": "feedzai-altair-theme",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7, <4",
"maintainer_email": "",
"keywords": "altair,theme,data,visualization",
"author": "Feedzai",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/43/59/caeddbb95e274b4aca4cccaffc3ae4deed4281c3939f92d2112cc23684f6/feedzai-altair-theme-1.1.2.tar.gz",
"platform": null,
"description": "# feedzai-altair-theme <img align=\"right\" src=\"https://raw.githubusercontent.com/feedzai/feedzai-altair-theme/master/assets/logo.svg\" height=\"96\" />\n\n[![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)\n\nFeedzai's theme for [Altair](https://github.com/altair-viz/altair) charts.\n\n## Sneak peek\n\n![Examples of charts with the feedzai-altair-theme applied](https://raw.githubusercontent.com/feedzai/feedzai-altair-theme/master/assets/header.svg)\n\n## Quickstart\n\n### Installation\n\nVia [pip](https://github.com/pypa/pip):\n\n```bash\npip install feedzai-altair-theme\n```\n\nVia [Pipenv](https://pipenv.pypa.io/):\n\n```bash\npipenv install feedzai-altair-theme\n```\n\nVia [Poetry](https://python-poetry.org/):\n\n```bash\npoetry add feedzai-altair-theme\n```\n\nVia [PDM](https://pdm.fming.dev/):\n\n```bash\npdm add feedzai-altair-theme\n```\n\nVia [Pyflow](https://github.com/David-OConnor/pyflow):\n\n```bash\npyflow install feedzai-altair-theme\n```\n\n### Usage\n\n```python\nimport altair as alt\n\nalt.themes.enable(\"feedzai\")\n```\n\nYou can find some example charts in the [`demo.ipynb` notebook](demo.ipynb).\n\n## Development\n\nCreate the development environment:\n\n```bash\nmake init\n```\n\nAfter 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`):\n\n```bash\nmake all\n```\n\nTo see the changes applied to some example charts, use the [`demo.ipynb` notebook](demo.ipynb):\n\n```bash\nmake demo\n```\n\n## Misc\n\n### Install the feedzai-altair-theme package in an environment without an Internet connection\n\nFirst, 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:\n\n```bash\npip install -e feedzai-altair-theme/ --no-deps --no-build-isolation\n```\n\nThis 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/).\n",
"bugtrack_url": null,
"license": "",
"summary": "Feedzai's theme for Altair charts.",
"version": "1.1.2",
"split_keywords": [
"altair",
"theme",
"data",
"visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "47f4fd722733e44e502b02b9224fe9f73cf0b730d62743fe208e8e8eccc2b8c6",
"md5": "3a0d6f8570e5b17767dc2d51787755f1",
"sha256": "c58cfc6f875b8ba03c41a946bd65713648b6326d0ba672761e8bd8ba1dd57a08"
},
"downloads": -1,
"filename": "feedzai_altair_theme-1.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3a0d6f8570e5b17767dc2d51787755f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7, <4",
"size": 12011,
"upload_time": "2023-01-13T15:43:27",
"upload_time_iso_8601": "2023-01-13T15:43:27.842616Z",
"url": "https://files.pythonhosted.org/packages/47/f4/fd722733e44e502b02b9224fe9f73cf0b730d62743fe208e8e8eccc2b8c6/feedzai_altair_theme-1.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4359caeddbb95e274b4aca4cccaffc3ae4deed4281c3939f92d2112cc23684f6",
"md5": "075081e97090f0e8d8289afc25f39b47",
"sha256": "8ae5155fe89995db509096cbd261e2bc9ad948842caf6741fd4717e9f8d6a116"
},
"downloads": -1,
"filename": "feedzai-altair-theme-1.1.2.tar.gz",
"has_sig": false,
"md5_digest": "075081e97090f0e8d8289afc25f39b47",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7, <4",
"size": 9726,
"upload_time": "2023-01-13T15:43:32",
"upload_time_iso_8601": "2023-01-13T15:43:32.982615Z",
"url": "https://files.pythonhosted.org/packages/43/59/caeddbb95e274b4aca4cccaffc3ae4deed4281c3939f92d2112cc23684f6/feedzai-altair-theme-1.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-13 15:43:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "feedzai",
"github_project": "feedzai-altair-theme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "feedzai-altair-theme"
}