# flake8-github
[](https://results.pre-commit.ci/latest/github/maxkrivich/flake8-github/main)
[](https://github.com/maxkrivich/flake8-github/blob/main/LICENSE)
[](https://pypi.org/project/flake8-github/)
[](https://github.com/maxkrivich/flake8-github/actions/workflows/ci.yaml)
> This extension seamlessly integrates with Flake8, providing clear and elegant error annotations directly on GitHub's interface, making it easier than ever to identify and address code issues during pull request reviews.
<img width="754" alt="image" src="https://github.com/maxkrivich/flake8-github/assets/12199867/1dda4022-0223-486d-ba8a-480338471a3d">
## Table of Contents
- [flake8-github](#flake8-github)
- [Table of Contents](#table-of-contents)
- [Installation](#installation)
- [Usage](#usage)
- [Local Development Setup](#local-development-setup)
- [Contributing](#contributing)
- [License](#license)
## Installation
Prerequisites
- flake8 = ^6.0.0
You can install `flake8-github` using pip:
```sh
$ pip install flake8-github
```
## Usage
After installing the formatter, you can enable it in your Flake8 configuration. For example, in your `.flake8`, `setup.cfg` file:
```
[flake8]
format = github
```
Run Flake8 as usual to start using github formatter:
```sh
$ flake8 src/ --format=github
```
## Local Development Setup
To contribute to this project or develop the plugin further locally, follow these steps:
1. Clone the repository:
```sh
$ git clone <https://github.com/your-username/flake8-github.git>
$ cd flake8-github
```
2. Create a virtual environment and install development dependencies:
```sh
$ pip install pre-commit poetry
$ pre-commit install
$ poetry install
```
3. How to bumpversion when you are done with the changes:
```sh
$ poetry self add poetry-bumpversion
$ poetry version {major, minor, patch, etc.}
```
Now you're ready to make changes and test your plugin locally.
## Contributing
Contributions are welcome! Please follow these guidelines:
1. Fork the repository.
2. Create a feature branch (git checkout -b feature/my-feature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin feature/my-feature).
5. Create a new Pull Request.
Please ensure your code adheres to the project's coding standards and includes tests.
## License
This project is licensed under MIT License - see the [LICENSE](https://github.com/maxkrivich/flake8-github/blob/master/LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": "https://github.com/maxkrivich/flake8-github",
"name": "flake8-github",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8.1,<4.0.0",
"maintainer_email": "",
"keywords": "flake8,github,actions,formatter,linter,qa,quality,assurance,plugin,report,reporter,output,output formatter,output formatter",
"author": "Max Kryvych",
"author_email": "me@kryvych.cc",
"download_url": "https://files.pythonhosted.org/packages/0a/3a/80084077d16625f3ee15869b9e7574734eca28024abe4d3b4861e2e17912/flake8_github-1.1.0.tar.gz",
"platform": null,
"description": "# flake8-github\n[](https://results.pre-commit.ci/latest/github/maxkrivich/flake8-github/main)\n[](https://github.com/maxkrivich/flake8-github/blob/main/LICENSE)\n[](https://pypi.org/project/flake8-github/)\n[](https://github.com/maxkrivich/flake8-github/actions/workflows/ci.yaml)\n\n\n\n> This extension seamlessly integrates with Flake8, providing clear and elegant error annotations directly on GitHub's interface, making it easier than ever to identify and address code issues during pull request reviews.\n\n<img width=\"754\" alt=\"image\" src=\"https://github.com/maxkrivich/flake8-github/assets/12199867/1dda4022-0223-486d-ba8a-480338471a3d\">\n\n## Table of Contents\n\n- [flake8-github](#flake8-github)\n - [Table of Contents](#table-of-contents)\n - [Installation](#installation)\n - [Usage](#usage)\n - [Local Development Setup](#local-development-setup)\n - [Contributing](#contributing)\n - [License](#license)\n\n## Installation\n\nPrerequisites\n\n- flake8 = ^6.0.0\n\nYou can install `flake8-github` using pip:\n\n```sh\n$ pip install flake8-github\n```\n\n## Usage\nAfter installing the formatter, you can enable it in your Flake8 configuration. For example, in your `.flake8`, `setup.cfg` file:\n\n```\n[flake8]\nformat = github\n```\n\n\nRun Flake8 as usual to start using github formatter:\n\n```sh\n$ flake8 src/ --format=github\n```\n\n\n## Local Development Setup\n\nTo contribute to this project or develop the plugin further locally, follow these steps:\n\n1. Clone the repository:\n```sh\n$ git clone <https://github.com/your-username/flake8-github.git>\n$ cd flake8-github\n```\n\n2. Create a virtual environment and install development dependencies:\n\n```sh\n$ pip install pre-commit poetry\n$ pre-commit install\n$ poetry install\n```\n\n3. How to bumpversion when you are done with the changes:\n```sh\n$ poetry self add poetry-bumpversion\n$ poetry version {major, minor, patch, etc.}\n```\n\nNow you're ready to make changes and test your plugin locally.\n\n\n## Contributing\n\nContributions are welcome! Please follow these guidelines:\n\n1. Fork the repository.\n2. Create a feature branch (git checkout -b feature/my-feature).\n3. Commit your changes (git commit -am 'Add some feature').\n4. Push to the branch (git push origin feature/my-feature).\n5. Create a new Pull Request.\n\nPlease ensure your code adheres to the project's coding standards and includes tests.\n\n\n## License\n\nThis project is licensed under MIT License - see the [LICENSE](https://github.com/maxkrivich/flake8-github/blob/master/LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Flake8 formatter for GitHub Actions",
"version": "1.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/maxkrivich/flake8-github/issues",
"Homepage": "https://github.com/maxkrivich/flake8-github",
"Repository": "https://github.com/maxkrivich/flake8-github"
},
"split_keywords": [
"flake8",
"github",
"actions",
"formatter",
"linter",
"qa",
"quality",
"assurance",
"plugin",
"report",
"reporter",
"output",
"output formatter",
"output formatter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e8f2b95262b4017b7587cb8a6ff6fee96398d8f1fe61bcc0e39a2f7f21f4867d",
"md5": "bf7a9163f3895f4525bb0b940653fc1a",
"sha256": "9d8dd632813995b0f8b7cba994066c18f55188a567926cc010da218077ddd196"
},
"downloads": -1,
"filename": "flake8_github-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf7a9163f3895f4525bb0b940653fc1a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.1,<4.0.0",
"size": 4338,
"upload_time": "2023-12-17T19:01:54",
"upload_time_iso_8601": "2023-12-17T19:01:54.208165Z",
"url": "https://files.pythonhosted.org/packages/e8/f2/b95262b4017b7587cb8a6ff6fee96398d8f1fe61bcc0e39a2f7f21f4867d/flake8_github-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0a3a80084077d16625f3ee15869b9e7574734eca28024abe4d3b4861e2e17912",
"md5": "ddbd6c745dd4fb372dbef2d319663396",
"sha256": "9951ddae9329a294e327ae9129680ed3d524847bf237cd2a5b5b89f1c9888cba"
},
"downloads": -1,
"filename": "flake8_github-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ddbd6c745dd4fb372dbef2d319663396",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.1,<4.0.0",
"size": 3842,
"upload_time": "2023-12-17T19:01:55",
"upload_time_iso_8601": "2023-12-17T19:01:55.653974Z",
"url": "https://files.pythonhosted.org/packages/0a/3a/80084077d16625f3ee15869b9e7574734eca28024abe4d3b4861e2e17912/flake8_github-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-17 19:01:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxkrivich",
"github_project": "flake8-github",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "flake8-github"
}
JSON
