[Epic] Migrate tutor and tutor-plugins to use ruff for linting and code formatting #1251
Description
Open edX upstream is planning to migrate to ruff and deprecate pydocstyle openedx/public-engineering#348. tutor uses a combination of pylint and black for linting and code formatting respectively. ruff is being used and adopted at a great pace, so we should also migrate tutor and tutor plugins to use ruff for linting and formatting.
Action items / PRs
- tutor (@DawoudSheraz / @ahmed-arb )
- tutor-android (feat: migrate from pylint/black to ruff tutor-android#41 by @Abdul-Muqadim-Arbisoft )
- tutor-cairn (feat: migrate from pylint/black to ruff tutor-cairn#69 by @Danyal-Faheem )
- tutor-credentials (feat: migrate from pylint/black to ruff tutor-credentials#57 by @mlabeeb03 )
- tutor-deck (feat: migrate from pylint/black to ruff tutor-deck#19 by @mlabeeb03 )
- tutor-discovery (feat: migrate from pylint/black to ruff tutor-discovery#104 by @mlabeeb03 )
- tutor-forum (feat: migrate from pylint/black to ruff tutor-forum#71 by @Abdul-Muqadim-Arbisoft )
- tutor-indigo (@HammadYousaf01 )
- tutor-jupyter (feat: migrate from pylint/black to ruff tutor-jupyter#31 by @Abdul-Muqadim-Arbisoft )
- tutor-mfe (feat: migrate from pylint/black to ruff tutor-mfe#266 by @rehmansheikh222 )
- tutor-minio (feat: migrate from pylint/black to ruff tutor-minio#64 by @Danyal-Faheem )
- tutor-notes (feat: migrate to ruff for linting and formatting checks tutor-notes#50 by @DawoudSheraz)
- tutor-xqueue (feat: migrate from pylint/black to ruff tutor-xqueue#42 by @rehmansheikh222 )
- cookiecutter-tutor-plugin (feat: migrate ruff cookiecutter-tutor-plugin#47 by @CodeWithEmad )
Related Links
- https://github.com/astral-sh/ruff
- https://pypi.org/project/pylint-to-ruff/
- How does ruff compare to pylint? astral-sh/ruff#689
- https://pythonspeed.com/articles/pylint-flake8-ruff/
Note
- Ensure all pylint rules enabled on tutor codebases are covered by ruff
- Ensure the make recipes are working as expected
- Fix any CI issues
- Ensure the image builds work correctly (it should not have any impact on image builds since this is CI/build change but better to verify it)