{"id":27424114,"url":"https://github.com/py-actions/flake8","last_synced_at":"2025-04-14T11:37:49.788Z","repository":{"id":37079882,"uuid":"262603455","full_name":"py-actions/flake8","owner":"py-actions","description":"A GitHub Action that installs and executes flake8 Python source linting during continuous integration testing.  Supports flake8 configuration and plugin installation in the GitHub Action settings.","archived":false,"fork":false,"pushed_at":"2024-08-19T20:34:41.000Z","size":1539,"stargazers_count":71,"open_issues_count":5,"forks_count":21,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-03T04:34:43.438Z","etag":null,"topics":["actions","ci","flake8","flake8-plugin","github-actions","lint","linter","linting","python","python3"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/py-actions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-09T15:43:04.000Z","updated_at":"2025-03-24T17:00:02.000Z","dependencies_parsed_at":"2023-11-10T20:25:05.943Z","dependency_job_id":"c22488c4-c9f9-431f-8c3c-072ff388dca6","html_url":"https://github.com/py-actions/flake8","commit_stats":{"total_commits":280,"total_committers":5,"mean_commits":56.0,"dds":"0.49642857142857144","last_synced_commit":"777f3c125938bc6e01d737c6306ecee8728cff24"},"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/py-actions%2Fflake8","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/py-actions%2Fflake8/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/py-actions%2Fflake8/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/py-actions%2Fflake8/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/py-actions","download_url":"https://codeload.github.com/py-actions/flake8/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248799931,"owners_count":21163403,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","ci","flake8","flake8-plugin","github-actions","lint","linter","linting","python","python3"],"created_at":"2025-04-14T11:37:48.715Z","updated_at":"2025-04-14T11:37:49.778Z","avatar_url":"https://github.com/py-actions.png","language":"JavaScript","readme":"# py-actions/flake8 GitHub Action\n\n![Version](https://img.shields.io/github/v/release/py-actions/flake8?sort=semver)\n[![Linux CI](https://github.com/py-actions/flake8/workflows/Linux%20CI/badge.svg)](https://github.com/py-actions/flake8/actions?query=workflow%3A%22Linux+CI%22)\n[![macOS CI](https://github.com/py-actions/flake8/workflows/macOS%20CI/badge.svg)](https://github.com/py-actions/flake8/actions?query=workflow%3A%22macOS+CI%22)\n[![Windows CI](https://github.com/py-actions/flake8/workflows/Windows%20CI/badge.svg)](https://github.com/py-actions/flake8/actions?query=workflow%3A%22Windows+CI%22)\n[![Lint](https://github.com/py-actions/flake8/workflows/Lint/badge.svg)](https://github.com/py-actions/flake8/actions?query=workflow%3ALint)\n[![CodeQL](https://github.com/py-actions/flake8/actions/workflows/codeql.yml/badge.svg)](https://github.com/py-actions/flake8/actions/workflows/codeql.yml)\n\nThis GitHub Action installs the Python [flake8 package](https://pypi.org/project/flake8/) in an environment with a Python interpreter and executes flake8 stylistic and logical linting of Python source files.  flake8 installation and execution defaults, and flake8 plugins can be configured with optional Action settings.\n\nThe project is tested against the latest GitHub Actions Linux, macOS, and Windows runner environment cPython versions 3.9.x - 3.12.x interpreters on a nightly basis.\n\n## Quick Start\n\n### Default\n\n```yaml\nname: flake8 Lint\n\non: [push, pull_request]\n\njobs:\n  flake8-lint:\n    runs-on: ubuntu-latest\n    name: Lint\n    steps:\n      - name: Check out source repository\n        uses: actions/checkout@v3\n      - name: Set up Python environment\n        uses: actions/setup-python@v4\n        with:\n          python-version: \"3.11\"\n      - name: flake8 Lint\n        uses: py-actions/flake8@v2\n```\n\n### With custom settings\n\n```yaml\nname: flake8 Lint\n\non: [push, pull_request]\n\njobs:\n  flake8-lint:\n    runs-on: ubuntu-latest\n    name: Lint\n    steps:\n      - name: Check out source repository\n        uses: actions/checkout@v3\n      - name: Set up Python environment\n        uses: actions/setup-python@v4\n        with:\n          python-version: \"3.11\"\n      - name: flake8 Lint\n        uses: py-actions/flake8@v2\n        with:\n          ignore: \"F401\"\n          exclude: \"src/ignoreme.py\"\n          max-line-length: \"100\"\n          path: \"src\"\n          plugins: \"flake8-bugbear==22.1.11 flake8-black\"\n```\n\nSee the Inputs section below for details on the defaults and optional configuration settings.\n\n## Inputs\n\nConfigure the Action with the following *optional* settings:\n\n### `flake8-version`\n\n**Optional** flake8 version for testing. Options: ['latest', 'main', 'master', '[VERSION NUMBER]'].Default = `\"latest\"`.\n\n- 'latest' = current PyPI release version\n- 'main' = current [GitHub source repository main branch version](https://github.com/PyCQA/flake8)\n- '[VERSION NUMBER]' = the version number of the [flake8 PyPI package](https://pypi.org/project/flake8/) (e.g., `\"3.7.9\"`)\n\n### `path`\n\n**Optional** The path to the Python source file(s) or directory. Default = `\".\"`.\n\n### `args`\n\n**Optional** Command line arguments to the flake8 executable. Default = None.\n\nPlease note that some command line arguments can be defined with other fields in your configuration.  You may combine the `args` setting with the other settings below, or use `args` to configure flake8 without the other Action settings.\n\nSee the inputs below for additional details.\n\n### `exclude`\n\n**Optional** Comma-delimited list of ignored file paths. Default = flake8 default.\n\n### `ignore`\n\n**Optional** Comma-delimited list of ignored flake8 rule codes. Default = flake8 default.\n\n### `max-line-length`\n\n**Optional** Integer value (as string) representing maximum acceptable line length. Default = flake8 default.\n\n### `update-pip`\n\n**Optional** Update `pip` before the flake8 install. Options: [`\"true\"`, `\"false\"`]. Default = `\"false\"`.\n\n### `plugins`\n\n**Optional** Space delimited list of flake8 plugin packages to install with pip prior to flake8 execution.  Default = none.\n\nUse the syntax:\n\n- `[PACKAGE NAME]`: for current PyPI release version across Action runs\n- `[PACKAGE NAME]==[VERSION]`: for a fixed PyPI release version on every Action run\n\nSee the [\"With custom settings\" example](#with-custom-settings) above.\n\n## Outputs\n\nNone\n\n## License\n\n[Apache License, v2.0](LICENSE)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpy-actions%2Fflake8","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpy-actions%2Fflake8","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpy-actions%2Fflake8/lists"}