Skip to content

Commit

Permalink
fix: kaleido won't install on Windows machines
Browse files Browse the repository at this point in the history
Put ``kaleido==0.0.3`` into ``pyproject.toml`` as this seems to be the
minimum version that works with Linux and Windows.

Closes #62
  • Loading branch information
andreas-vester committed Dec 5, 2023
1 parent b72575e commit 4754a91
Show file tree
Hide file tree
Showing 4 changed files with 258 additions and 247 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
### Fixed
- kaleido won't install on Windows machines using pdm package manager ([GH issue #62](https://github.com/andreas-vester/df2img/issues/62)).

## [0.2.15] - 2023-11-23
### Changed
Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,15 @@ It is a wrapper/convenience function in order to create a ``plotly`` Table. That
An extensive documentation is available at https://df2img.dev.


## Important note
The ``kaleido`` dependency is needed to save a ``pd.DataFrame``. Right now there is an
issue when using the latest version of ``kaleido``.
This project requires ``kaleido v0.0.3`` when you are installing ``df2img`` on a Linux
machine. This version has been set as the minimum version in the ``pyproject.toml``
file.
However, when you're on a Windows machine, you can use ``kaleido v0.1.0.post1`` at a
maximum. That is, it is recommended to manually upgrade to this version.

## Quickstart

You can install the package via ``pip``.
Expand All @@ -37,10 +46,11 @@ You can install the package via ``pip``.
pip install df2img
```

Using ``poetry``?
Using ``poetry`` or ``pdm``?

```bash
poetry add df2img
pdm add df2img
```

Let's create a simple ``pd.DataFrame`` with some dummy data:
Expand Down
Loading

0 comments on commit 4754a91

Please sign in to comment.