> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# qventus/python-lint

Use this orb to run flake8 linting according to the settings.cfg in your repository.
Detects the changes to base of PR (or last commit if run with compare-to-pr-root: false) and run flake8 on py files.


## Commands

### lint

Run flake8 on files with git diff

| Parameter | Type | Default | Description |
|---|---|---|---|
| `working-directory` | string | . | Directory path for this job |
| `checkout` | boolean | true | Bool to checkout as a first step |
| `attach-workspace` | boolean | false | Bool to attach to an existing workspace |
| `workspace-root` | string | . | Workspace root path |
| `compare-to-pr-root` | boolean | true | Use GITHUB_API_TOKEN to find where pull is getting merged into and find all changed files |

## Jobs

### lint

Lint python files

| Parameter | Type | Default | Description |
|---|---|---|---|
| `pyversion` | string | 3.10 | Python version for executor |
| `working-directory` | string | . | Directory path for this job |
| `checkout` | boolean | true | Bool to checkout as a first step |
| `attach-workspace` | boolean | false | Bool to attach to an existing workspace |
| `workspace-root` | string | . | Workspace root path |
| `compare-to-pr-root` | boolean | true | Use GITHUB_API_TOKEN to find where pull is getting merged into and find all changed files |

## Executors

### python-lint

| Parameter | Type | Default | Description |
|---|---|---|---|
| `pyversion` | string | 3.10 | Python version for executor |
| `working-directory` | string | . | Directory path for this job |

## Examples

### python-lint

Usage

```yaml
orbs:
  pylint: qventus/python-lint@volatile
version: 2.1
workflows:
  build:
    jobs:
      - pylint/lint
```