isort VS Pylint

isort: This library sorts your imports alphabetically, and automatically separates them into sections and by type. It provides a cleaner and more organised way to manage project imports.

isort will sort the imports for you

isort is a Python utility that helps in sorting and organizing import statements in Python code to create readable and consistent code. It automatically formats import statements in accordance with PEP 8.

repos: - repo: https://github.com/ambv/black rev: 23.3.0 hooks: - id: black args: [--config=./pyproject.toml] language_version: python3.11 - repo: https://github.com/pycqa/flake8 rev: 6.0.0 hooks: - id: flake8 args: [--config=./tox.ini] language_version: python3.11 - repo: https://github.com/pycqa/isort rev: 5.12.0 hooks: - id: isort args: ["--profile", "black", "--filter-files"] language_version: python3.11 - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.4.0 hooks: - id: requirements-txt-fixer language_version: python3.11 - id: debug-statements - id: detect-aws-credentials - id: detect-private-key

repos: ... pre-commmit stuff ... black stuff - repo: https://github.com/pycqa/isort rev: 5.12.0 hooks: - id: isort name: isort (python)

isort

isort , A Python utility / library to sort imports.

Install black and isort and just don't worry about it. :-)

Sure. Also, and don't take this the wrong way, but there are some code smells in your project that could be partially mitigated with some basic linting/formatting. I suggest black as a code formatter, flake8 for basic linting, and isort for sorting imports (for example, you have local imports mixed in with standard library and third party imports). You can install these via pip and most editors (like VS Code) can autoformat on save and show you linting problems as you edit. And you can integrate these into your workflow by using pre-commit.

A little introduction about pylint. Pylint is a static code analyzer, it analyses your code without actually running it. Pylint looks for potential errors, gives suggestions on coding standards that your code is not adhering to, potential places where refactoring might help, and also warnings about smelly code.

Pylint, on the other hand, focuses on code analysis and style checking. It offers extensive customization options and supports various coding standards. Pylint is known for its comprehensive reports and ability to detect a wide range of code issues.

In my opinion, the best way to expose configuration options is to read and parse them from the project's pyproject.toml file. Here's how Pylint handles it.

I even contributed to Pylint by submitting a new rule a few years ago : implicit-str-concat.

Implemented code formatting with Black and linting with Pylint in my CI pipeline. Here is my updated GitHub Actions Workflow file: ci.yml

One last thing to do before running the hooks is to create a config file, just like we did with flake8. For this you are going to create a pylintrc file at the roor of your project and copy the contents of the pylintrc file from the pylint repo (here is the link to it).