Skip to content

Commit 2b43e4f

Browse files
chore: Update docs
1 parent 5c5c5cd commit 2b43e4f

File tree

5 files changed

+215
-297
lines changed

5 files changed

+215
-297
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -207,11 +207,12 @@ how to contribute to an open source project. In a nutshell, the process involves
207207
<!-- omit in toc -->
208208
#### How do I set up my dev environment?
209209

210-
**df2img** uses [pdm](https://pdm.fming.dev/) to manage its dependencies. So make sure you have it properly
210+
**df2img** uses [uv](https://docs.astral.sh/uv/) to manage its dependencies. So make sure
211+
you have it properly
211212
installed before you go on. To set up your development environment, you should install the project after you cloned
212213
the repo to your local machine:
213214
```shell
214-
pdm install -d
215+
uv sync
215216
```
216217

217218
The **df2img** package adheres to a bunch of [Style guides](#style-guides), that
@@ -229,24 +230,9 @@ have the chance to fix all issues and re-commit your code changes.
229230
In concrete, besides ``pre-commit``'s native checks, the following hooks have been
230231
implemented (in alphabetical order):
231232

232-
* [black](https://pypi.org/project/black/): The Uncompromising Code Formatter
233-
* [ruff](https://pypi.org/project/ruff/): An extremely fast Python linter, written in Rust, with the following options
234-
enabled:
235-
236-
* Pyflakes
237-
* Pycodestyle
238-
* isort
239-
* pep8-naming
240-
* docstring
241-
* pyupgrade
242-
* flake8-annotations
243-
* flake8-bugbear
244-
* flake8-builtins
245-
* flake8-comprehensions
246-
* flake8-unused-arguments
247-
* flake8-use-pathlib
248-
* flake8-eradicate
249-
* flake8-simplify
233+
* kacl-cli verify
234+
* ruff check .
235+
* ruff format .
250236

251237
You can install the hooks with (runs for each commit):
252238

@@ -272,24 +258,7 @@ pre-commit run --all-files
272258

273259
Running simple unit tests using ``pytest`` is as easy as
274260
```shell
275-
pdm run pytest
276-
```
277-
278-
In addition, you can perform more rigorous linting and tests against multiple Python
279-
versions. In this case, the test result depends on the Python versions available on
280-
your machine. Make sure, you've got at least Python 3.8 installed on your machine.
281-
Then simply run:
282-
```shell
283-
pdm run nox
284-
```
285-
If all tests pass, you should get a result comparable to this:
286-
```shell
287-
nox > Ran multiple sessions:
288-
nox > * pre-commit: success
289-
nox > * tests-3.8: success
290-
nox > * tests-3.9: success
291-
nox > * tests-3.10: success
292-
nox > * tests-3.11: success
261+
uv run pytest
293262
```
294263

295264
### Improving The Documentation
@@ -304,13 +273,7 @@ don't hesitate to open an [issue](https://github.com/andreas-vester/df2img/issue
304273

305274
## Style guides
306275

307-
### Code formatting
308-
309-
This project uses the [black](https://black.readthedocs.io/) formatter to automatically format the code basis.
310-
The line length has been set to 88 characters.
311-
312-
### Linting
313-
276+
### Code formatting and linting
314277
We use [ruff](https://pypi.org/project/ruff/) as our tool of choice for style guide enforcement. That means,
315278
contributors should adhere to the following points (not exhaustive):
316279

README.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,6 @@ machine other than Windows.
3636
However, when you're on a Windows machine, you must use ``kaleido==v0.1.0.post1``.
3737
The dependency specification in the ``pyproject.toml`` file takes care of this.
3838

39-
Having said this, if you're not on Windows and using the
40-
[pdm](https://pdm-project.org/en/stable/) package manager, ``kaleido`` won't get
41-
installed at all due to a [bug](https://github.com/pdm-project/pdm/issues/46) in
42-
[pdm](https://pdm-project.org/en/stable/). In that case the following workaround might
43-
be helpful:
44-
- activate your virtual environment: ``source .venv/bin/activate``
45-
- use ``pip`` in order to install ``kaleido`` separately: ``pip install kaleido==0.2.1``
46-
47-
4839
## Quickstart
4940

5041
You can install the package via ``pip``.
@@ -53,11 +44,10 @@ You can install the package via ``pip``.
5344
pip install df2img
5445
```
5546

56-
Using ``poetry`` or ``pdm``?
47+
Using ``uv``?
5748

5849
```bash
59-
poetry add df2img
60-
pdm add df2img
50+
uv add df2img
6151
```
6252

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

docs/installation.md

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,10 @@ You can install the package via ``pip``.
77
```bash
88
pip install df2img
99
```
10-
Using ``poetry`` or ``pdm``?
10+
Using ``uv``?
1111

1212
```bash
13-
poetry add df2img
14-
pdm add df2img
13+
uv add df2img
1514
```
1615

1716
## Important note
@@ -21,11 +20,3 @@ This project requires ``kaleido==v0.2.1`` when you are installing ``df2img`` on
2120
machine other than Windows.
2221
However, when you're on a Windows machine, you must use ``kaleido==v0.1.0.post1``.
2322
The dependency specification in the ``pyproject.toml`` file takes care of this.
24-
25-
Having said this, if you're not on Windows and using the
26-
[pdm](https://pdm-project.org/en/stable/) package manager, ``kaleido`` won't get
27-
installed at all due to a [bug](https://github.com/pdm-project/pdm/issues/46) in
28-
[pdm](https://pdm-project.org/en/stable/). In that case the following workaround might
29-
be helpful:
30-
- activate your virtual environment: ``source .venv/bin/activate``
31-
- use ``pip`` in order to install ``kaleido`` separately: ``pip install kaleido==0.2.1``

noxfile.py

Lines changed: 0 additions & 36 deletions
This file was deleted.

0 commit comments

Comments
 (0)