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

# rdgozum/python

Reusable Python orb for your CircleCI pipeline.


## Commands

### black

Run black command on specified src.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `src` | string | src | Path to the directory containing the python files. |

### flake8

Run flake8 command on specified src.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `src` | string | src | Path to the directory containing the python files. |

### pylint

Run pylint command on specified src.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `src` | string | src | Path to the directory containing the python files. |

## Jobs

### black

Perform black formatting on python files.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `checkout` | boolean | true | Boolean for whether or not to checkout as a first step. Defaults to true.
 |
| `executor` | executor | default | The docker container to use for black formatting on python files. |
| `src` | string | . | Path to the directory containing the python files. Defaults to the project's root directory. |

### flake8

Perform flake8 validation on python files.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `checkout` | boolean | true | Boolean for whether or not to checkout as a first step. Defaults to true.
 |
| `executor` | executor | flake8 | The docker container to use for flake8 validation on python files. Defaults to flake8. |
| `src` | string | . | Path to the directory containing the python files. Defaults to the project's root directory. |

### pylint

Perform pylint validation on python files.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `checkout` | boolean | true | Boolean for whether or not to checkout as a first step. Defaults to true.
 |
| `executor` | executor | default | The docker container to use for pylint validation on python files. |
| `src` | string | . | Path to the directory containing the python files. Defaults to the project's root directory. |

## Executors

### default

The docker container default for python.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `version` | string | 3.9.0 | Python version for executor |

### flake8

The docker container to use for flake8 validation on python files.


| Parameter | Type | Default | Description |
|---|---|---|---|
| `tag` | string | 3.8.4 | Docker tag |

## Examples

### static_check

Perform linting on python files using flake8, pylint, and black.


```yaml
version: '2.1'
orbs:
  python: rdgozum/python@x.y.z
workflows:
  main:
    jobs:
      - python/flake8
      - python/pylint
      - python/black
```