pyroll-project / pyroll-core

PyRoll rolling simulation framework - core library.
https://pyroll.readthedocs.io
BSD 3-Clause "New" or "Revised" License
12 stars 7 forks source link

Pylint #100

Closed ChRen95 closed 10 months ago

ChRen95 commented 1 year ago

If created a little test with pylint. Pylint is a too that rates the quality of the provided code under the following conditions:

Code Quality Checks: Pylint checks Python code against a set of coding standards and guidelines. It looks for issues such as indentation errors, undefined variables, unused imports, and other common coding mistakes.

PEP 8 Compliance: Pylint enforces the Python Enhancement Proposal (PEP) 8 style guide, which is the de facto style guide for Python code. This helps ensure code consistency and readability.

Code Smell Detection: Pylint can identify potential code smells, which are not necessarily errors but may indicate areas for improvement. Code smells can include overly complex code, duplicated code, and more.

Customizable: Pylint is highly configurable. Developers can adjust the tool's behavior by specifying or modifying various settings and rules to match their project's specific requirements.

Integration with IDEs: Pylint can be integrated with various integrated development environments (IDEs) such as Visual Studio Code, PyCharm, and others. This allows developers to receive real-time feedback on their code as they write it.

Output Formats: Pylint provides various output formats, including text, HTML, and JSON, making it versatile in how the analysis results are presented.

Extensibility: Developers can write their own Pylint plugins to extend its capabilities or tailor it to specific project requirements

I think it's a great test to add after we defined our own standards to keep the code clean in the future. Feel free to play around with test before merging.