Skip to content

Latest commit

 

History

History
79 lines (67 loc) · 3.03 KB

README.md

File metadata and controls

79 lines (67 loc) · 3.03 KB
Raw

Certego

🐍 Python linters

🔧 Dependencies

To use locally, install these dependencies:

pip install -r requirements-linters.txt

To add additional dependecies to CI, insert them in your personal requirements-linters.txt file (inside <requirements_path> folder).

📖 How to use

Customize files inside configurations.

Note: actually there is no way to extend configurations with other files.

💻 How to configure your IDE

Since linters configurations aren't directly in the project tree, if you use liting plugins in your editor, you have to instruct them about correct path.
Here are some examples:

In .vscode/settings.json

{
    "editor.formatOnSave": true,
    "python.defaultInterpreterPath": "~/.virtualenvs/website/bin/python",
    "[python]": {
        "editor.defaultFormatter": "ms-python.black-formatter",
        "editor.codeActionsOnSave": {
            "source.organizeImports": true
        }
    },
    "isort.importStrategy": "fromEnvironment",
    "isort.check": true,
    "isort.args": [
        "--sp=${workspaceFolder}/.github/configurations/python_linters/.isort.cfg"
    ],
    "pylint.importStrategy": "fromEnvironment",
    "pylint.args": [
        "--rcfile=${workspaceFolder}/.github/configurations/python_linters/.pylintrc",
        "-v"
    ],
    "flake8.importStrategy": "fromEnvironment",
    "flake8.args": [
        "--config=${workspaceFolder}/.github/configurations/python_linters/.flake8"
    ],
    "black-formatter.importStrategy": "fromEnvironment",
    "black-formatter.args": [
        "--config",
        "${workspaceFolder}/.github/configurations/python_linters/.black"
    ]
}

Linters can be run on demand as external tools in the IDE by adding their configurations under File -> Settings... -> Tools -> External tools. Then, add a configuration for each linter by clicking on the + button (the working directory must be set to the folder where the manage.py file is). After this configurations, the linters can be run from the menu Tools -> External tools.

  • Flake8
    • Name: Flake8
    • Program: $PyInterpreterDirectory$/flake8
    • Arguments: $FilePath$ --config ../.github/configurations/python_linters/.flake8
    • Working directory: $ProjectFileDir$/DjangoMainProject
  • Black
    • Name: Black
    • Program: $PyInterpreterDirectory$/black
    • Arguments: --config ../.github/configurations/python_linters/.black $FilePath$
    • Working directory: $ProjectFileDir$/DjangoMainProject
  • isort
    • Name: isort
    • Program: $PyInterpreterDirectory$/isort
    • Arguments: --sp ../.github/configurations/python_linters/.isort.cfg --profile black $FilePath$
    • Working directory: $ProjectFileDir$/DjangoMainProject

With this configuration, the linters are run against the opened file in the editor; to do it against the whole codebase, change the variable $FilePath$ to the Django root directory.