Skip to content

Commit 4754a91

Browse files
fix: kaleido won't install on Windows machines
Put ``kaleido==0.0.3`` into ``pyproject.toml`` as this seems to be the minimum version that works with Linux and Windows. Closes #62
1 parent b72575e commit 4754a91

File tree

4 files changed

+258
-247
lines changed

4 files changed

+258
-247
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.
44
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).
55

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

810
## [0.2.15] - 2023-11-23
911
### Changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,15 @@ It is a wrapper/convenience function in order to create a ``plotly`` Table. That
2929
An extensive documentation is available at https://df2img.dev.
3030

3131

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

3443
You can install the package via ``pip``.
@@ -37,10 +46,11 @@ You can install the package via ``pip``.
3746
pip install df2img
3847
```
3948

40-
Using ``poetry``?
49+
Using ``poetry`` or ``pdm``?
4150

4251
```bash
4352
poetry add df2img
53+
pdm add df2img
4454
```
4555

4656
Let's create a simple ``pd.DataFrame`` with some dummy data:

0 commit comments

Comments
 (0)