🚀 Added Flake8 CI Github-Action For Python

taljacob2 commented 2 years ago

Flake8 is a CI tool that checks the code written in python.

For example, it checks that the max-line-length is below 120 characters.

Added Support For Flake8 In The Project
- Added Flake8 as a dependency for Pipenv sync.
- How To Use Flake8: After running the commands:
```
vagrant up
vagrant ssh
cd /vagrant
```
  you may run Flake8 and review your code, by running the command:
```
pipenv run flake8 --max-line-length 120
```
Added Support For Github's PRs To CI With Flake8 When contributing a PR, Github will now review the code in it with Flake8, and will print the results of it.

DEPENDS ON #5

ATTENTION: Because of insufficient writing-permissions to this repository, it is required that @Yarboa, @kasemAlem will setup branch-protection of the main branch, so this PR would close #8

Signed-off-by: taljacob2 taljacob2@gmail.com

taljacob2 commented 2 years ago

Must be documented in README

Alright. I will create a special README file that explains all the information about the Flake8 tool and how to use it. I will place it in a new README folder.

taljacob2 commented 2 years ago

Updates of today:

@kasemAlem : There is a new README file for Flake8, that explains how to use it.
@Yarboa : This PR now contains only the files added in this new feature.

Please review the new changes.

taljacob2 commented 2 years ago

Consider renaming README dir to docs

Done. The Flake8's README is now placed at: docs/Flake8.md

redhat-beyond / JobSeeker

🚀 Added Flake8 CI Github-Action For Python #10