Merge pull request #483 from radish-bdd/feature/switch-to-ruff

Switch to ruff

Author: fliiiix

.github/CONTRIBUTING.md

@@ -30,34 +30,22 @@ We are very happy to receive Pull Requests considering:
 
 ## Development
 
-radish uses the *extra* requirements feature of `setuptools` to specify all
-the dependencies needed to develop radish.
-A set of extra requirements can be installed with the following `pip` syntax:
+radish can be installed as [editable install](https://setuptools.pypa.io/en/latest/userguide/development_mode.html).
 
 ```bash
-pip install -e '.[<extras>]'
+pip install -r requirements-dev.txt
+pip install -e .
 ```
 
-whereas `<extras>` can be one of:
-
-* `tests`: all dependencies required to run the radish unit and integration tests
-* `docs`: all dependencies required to build the radish documentation
-* `dev`: all dependencies required to develop radish. This group includes the `tests` and `docs` dependencies. [recommended]
-
 ### tox: linting, testing, docs & more
 
 radish uses [`tox`](https://tox.readthedocs.io/en/latest/) to automate development tasks,
 like linting, testing, building the docs and creating the changelog.
 
 The radish tox setup provides the following automated tasks:
 
-* `lint`: formats and lints the code base using [`black`](https://black.readthedocs.io/en/stable/) and [`flake8`](https://flake8.readthedocs.io/en/stable/).
-* `manifest`: checks if the `MANIFEST.in` content is consistent with the repository content.
-* `py<ver>`: runs unit tests with the Python Version from `<ver>`.
-* `integration`: runs integration tests.
-* `coverage-report`: generates a coverage report. Make sure that you've run some tests before.
-* `docs`: builds the sphinx documentation.
-* `news`: generates the ChangeLog from the newsfragments in `changelog/`. Use `towncrier --draft` directly to generate a ChangeLog draft.
+* `lint`: formats and lints the code base using [`ruff`](https://docs.astral.sh/ruff/)
+* `py<ver>`: runs tests with the Python Version from `<ver>`.
 
 Before commiting your changes, it's a good practice to run `tox`.
 So that it'll run all the preconfigured tasks.

.github/workflows/main.yml

@@ -12,18 +12,19 @@ jobs:
         with:
           python-version: 3.13
       - name: Setup and install tools
-        run: |
-          python -m pip install --upgrade black
-      - name: black format check
-        run: black --check --line-length 120 radish/ tests/ setup.py
+        run: python -m pip install ruff
+      - name: ruff format check
+        run: ruff format --check
+      - name: ruff check
+        run: ruff check
 
   test:
     strategy:
       fail-fast: false
       max-parallel: 8
       matrix:
         python-version: [3.7, 3.13]
-        os: [ubuntu-latest, windows-latest, macOS-latest]
+        os: [ubuntu-22.04, windows-latest, macos-latest]
         exclude:
         - os: macos-latest
           python-version: 3.7

.gitignore

@@ -9,6 +9,7 @@
 
 # python virtualenv
 env*
+.env*
 
 # python tox files
 .tox

AUTHORS

@@ -1,5 +1,6 @@
 radish was originally created in September 2012 by Timo Furrer
 and was completely refactored in June 2015.
+Maintained since 2020 by Fliiiix.
 
 Here is an inevitably incomplete list of MUCH-APPRECIATED CONTRIBUTORS --
 people who have submitted patches, reported bugs, added translations, helped

CONTRIBUTING.md

@@ -4,7 +4,6 @@ include *.rst
 include *.txt
 include AUTHORS
 include LICENSE
-include pylintrc
 include tox.ini
 recursive-include doc *.png
 recursive-include doc *.py