@@ -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
211212installed before you go on. To set up your development environment, you should install the project after you cloned
212213the repo to your local machine:
213214``` shell
214- pdm install -d
215+ uv sync
215216```
216217
217218The ** 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.
229230In concrete, besides `` pre-commit `` 's native checks, the following hooks have been
230231implemented (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
251237You can install the hooks with (runs for each commit):
252238
@@ -272,24 +258,7 @@ pre-commit run --all-files
272258
273259Running 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
314277We use [ ruff] ( https://pypi.org/project/ruff/ ) as our tool of choice for style guide enforcement. That means,
315278contributors should adhere to the following points (not exhaustive):
316279
0 commit comments