{"id":22751806,"url":"https://github.com/grantmcconnaughey/flake8rules","last_synced_at":"2025-04-07T08:20:36.242Z","repository":{"id":40011991,"uuid":"112145096","full_name":"grantmcconnaughey/Flake8Rules","owner":"grantmcconnaughey","description":"Descriptions and examples for the rules in Flake8 (pyflakes, pycodestyle, and mccabe).","archived":false,"fork":false,"pushed_at":"2023-11-24T10:09:30.000Z","size":134,"stargazers_count":242,"open_issues_count":19,"forks_count":36,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-31T06:08:37.583Z","etag":null,"topics":["flake8","mccabe","pycodestyle","pyflakes","python"],"latest_commit_sha":null,"homepage":"https://www.flake8rules.com","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/grantmcconnaughey.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2017-11-27T03:58:58.000Z","updated_at":"2025-03-19T14:20:45.000Z","dependencies_parsed_at":"2024-11-13T07:31:08.314Z","dependency_job_id":"84d15444-c740-48a9-89be-1855d68bd45c","html_url":"https://github.com/grantmcconnaughey/Flake8Rules","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grantmcconnaughey%2FFlake8Rules","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grantmcconnaughey%2FFlake8Rules/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grantmcconnaughey%2FFlake8Rules/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/grantmcconnaughey%2FFlake8Rules/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/grantmcconnaughey","download_url":"https://codeload.github.com/grantmcconnaughey/Flake8Rules/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247615385,"owners_count":20967184,"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":["flake8","mccabe","pycodestyle","pyflakes","python"],"created_at":"2024-12-11T05:07:25.709Z","updated_at":"2025-04-07T08:20:36.221Z","avatar_url":"https://github.com/grantmcconnaughey.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flake8 Rules\n\nDocumentation and examples for the rules in [Flake8](http://flake8.pycqa.org/en/latest/index.html) ([pyflakes](https://github.com/PyCQA/pyflakes), [pycodestyle](http://pycodestyle.pycqa.org/en/latest/), and [mccabe](https://github.com/pycqa/mccabe)).\n\n## API\n\nFlake8 Rules includes simple API with two endpoints.\n\n### Retrieve a single rule\n\nThis endpoints returns a single Flake8 rule.\n\n**Heads up:** This endpoint returns JSON content but the Content-Type is set to `text/html`. This is due to Jekyll's inability to generate files with permalinks that end in `.json`.\n\n```\n$ curl https://www.flake8rules.com/api/rules/E111/\n{\n    \"code\": \"E111\",\n    \"message\": \"Indentation is not a multiple of four\",\n    \"content\": \"The rendered HTML content\",\n    \"links\": [\"https://www.python.org/dev/peps/pep-0008/#indentation\"]\n}\n```\n\n* `code` - The 4 character Flake8 issue code.\n* `message` - A short message describing the issue.\n* `content` - The fully rendered HTML content describing the issue and how to fix it.\n* `links` - A list of additional links to visit for more information.\n\n### Retrieve a list of all rules\n\nThis endpoint returns a list of all Flake8 rules.\n\n```\n$ curl https://www.flake8rules.com/api/rules.json\n[\n    {\n        \"code\": \"F812\",\n        \"message\": \"List comprehension redefines name from line n\",\n        \"content\": \"The rendered HTML content\",\n        \"links\": [\"https://docs.python.org/2/tutorial/datastructures.html#list-comprehensions\"]\n    }\n]\n```\n\n## Contributing\n\nAll rules go in the `_rules` directory. They should be named with their 4 character code, like `E301.md`.\n\nTo run the jekyll development server first [install Jekyll](https://jekyllrb.com/docs/installation/). Then run the following:\n\n```\n$ bundle exec jekyll serve\n```\n\n### Documenting Errors\n\n* pyflakes error codes: http://flake8.pycqa.org/en/latest/user/error-codes.html#error-violation-codes\n* pycodestyle error codes: http://pycodestyle.pycqa.org/en/latest/intro.html#error-codes\n\nExamples of pycodestyle error violations can be found in the project's [test suite](https://github.com/PyCQA/pycodestyle/tree/master/testsuite). This is useful for understanding violations and documenting them.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrantmcconnaughey%2Fflake8rules","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgrantmcconnaughey%2Fflake8rules","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgrantmcconnaughey%2Fflake8rules/lists"}