Use ruff as linter and formatter (#337)

Use ruff as linter and formatter 

---------

Co-authored-by: Mohcine Chraibi <m.chraibi@fz-juelich.de>

Author: schroedtert

.pylintrc

@@ -5,13 +5,11 @@
 
 -----------------
 [![PyPI Latest Release](https://img.shields.io/pypi/v/pedpy.svg)](https://pypi.org/project/pedpy/)
-[![Nightly Release](https://img.shields.io/badge/nightly-install-9cf)](https://test.pypi.org/project/PedPy/)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pedpy)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7194992.svg)](https://doi.org/10.5281/zenodo.7194992)
 [![License](https://img.shields.io/pypi/l/pedpy.svg)](https://github.com/PedestrianDynamics/pedpy/blob/main/LICENSE)
 ![ci workflow](https://github.com/PedestrianDynamics/pedestrian-trajectory-analyzer/actions/workflows/ci.yml/badge.svg)
-[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 [![Documentation Status](https://readthedocs.org/projects/pedpy/badge/?version=latest)](http://pedpy.readthedocs.io/?badge=latest)
 [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/7046/badge)](https://bestpractices.coreinfrastructure.org/projects/7046)
 [![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu)

README.md

@@ -256,25 +256,25 @@ Except from the functional requirements (see :ref:`Tests`) for changes in the co
 These will also be checked in our CI process for each Pull Request.
 
 1. **Code formatting:**
-To ensure that your Pull Request may get accepted, make sure that the code is formatted with ``black``.
+To ensure that your Pull Request may get accepted, make sure that the code is formatted with ``ruff format``.
 We provide a helper script (``scripts/format.sh``) that will format every file in the correct manner.
 To test it locally you can use ``scripts/check-format.sh``.
 
-2. **Docstring style:**
-Make sure to check whether every of your new functions has a docstring.
-We decided to use Google-docstring style to be used in our project.
-You can use `pydocstyle` to check if everything is correct locally.
-
-3. **Type Hints:**
+2. **Type Hints:**
 We decided that every function, parameter, return value, etc. should be annotated with type hints, as they make it clearer for users what to expect and what is needed.
 For ensuring that no type hint is forgotten we use ``MyPy``.
 This can be checked locally via ``python3 -m mypy --config-file mypy.ini pedpy/``
 
-4. **Linting:**
+3. **Linting:**
 Linting in Python is an important process that helps ensure that our code is consistent and adheres to best practices.
-Linting tools like ``pylint`` analyze our code for potential errors, bad practices, and code smells.
+Linting tools like ``ruff`` analyze our code for potential errors, bad practices, and code smells.
 This helps us catch issues early on and prevents them from becoming bigger problems down the line.
 
+4. **Docstring style:** (included in linting)
+Make sure to check whether every of your new functions has a docstring.
+We decided to use Google-docstring style to be used in our project.
+You can use `ruff` to check if everything is correct locally.
+
 If you want to run the same tests as in the CI pipeline, you can use ``scripts/ci.sh``.
 
 Update documentation