Add pre-commit

[michalslowikowski00]

Hello.

I would like to add pre-commit to the project.
IMHO this is a great and helpful tool for checking code before committing.
I have add few checks.
You can read about pre-commit here:
https://pre-commit.com/#install

What do you think about it?

PR contains:

• pre-commit setup
• pre-commit checks: black, isort, flake8, pydocstyle

[turbaszek]

Suggested change

	repos:
	---
	default_stages: [commit, push]
	default_language_version:
	# force all unspecified python hooks to run python3
	python: python3
	minimum_pre_commit_version: "1.20.0"
	repos:

[michalslowikowski00]

Cool. I wasn't sure which python do we want to support.

[michalslowikowski00]

Can we leave this hook in this PR?

- repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v2.3.0
    hooks:
      - id: check-yaml
      - id: end-of-file-fixer
      - id: trailing-whitespace

[turbaszek]

Sounds reasonable to me but as mentioned in https://github.com/apache/kibble/pull/44#pullrequestreview-505801054 it would be good to run pre-commit run --all-files to check all files

[turbaszek]

I would be in favor of introducing them in follow up PRs.

[michalslowikowski00]

I agree. I will move these hooks to separate PR.

[turbaszek]

Overall it looks good to me. But introducing pre-commit without actual changes (unless there are none to be applied) to files gives us nothing in my opinion. I would be in favor of introducing a simple Github Action CI that would run pre-commit.

This should do:

name: CI
on:
  - push
  - pull_request

jobs:
  statics:
    name: Static Checks
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions/setup-python@v1
      - uses: pre-commit/action@v1.0.1

In this way if CI fails we will need to fix some issue and everyone will be able to see how pre-commit works and what problems are being detected.

[sharanf]

@michalslowikowski00 @turbaszek thanks for helping move this initiative forward. I have highlighted that this work is now in progress and if anyone wants to contribute to this effort then they can join this conversation.

[sharanf]

I will merge what has been done far.