Evaluate Ruff vs. Black for Python Codebase

[skyl]

Background

The Corpora project currently uses Black for Python code formatting as mentioned in the TODO.md. However, there is a consideration to potentially use Ruff, another tool for static code analysis and formatting in Python.

Task

1. Compare Ruff and Black:

   • Evaluate the differences between Ruff and Black in terms of features, ease of use, integration capabilities, and community support.
   • Identify what other static code checkers can complement Black if we continue to use it.
   • Determine if Ruff can serve as a standalone solution or if it needs to be used in conjunction with other tools.

2. Compatibility with the Multi-Package Structure:

   • Assess how easily Ruff and Black can be integrated into the existing multi-package repository structure of Corpora.
   • Identify any potential issues or benefits in terms of maintainability and setup.

3. Documentation & Best Practices:

   • Provide guidelines or document best practices on how to implement Ruff or Black in the current setup, focusing on usage in a development container as indicated in the README.md file.
   • Ensure that any new tools or methods align with the project’s emphasis on scalable, modular, and top-quality software development.

Deliverables

• A report summarizing the findings, including recommendations on which tool(s) to use.
• An update to the requirements-dev.txt if any changes are recommended.
• Proposed changes or additions to the project documentation that reflect the chosen solution.

Context Related Files

• requirements-dev.txt
• README.md
• TODO.md

[skyl]

62 - might as well go with ruff