Enhance Code Quality with Ruff, Black, and Pre-commit (#456)

* add: linter, formatter for github actions

* add: CONTRIBUTING.md

* add: pre-commit config and pre-commit rule

* fix: auto-fix with ruff

* fix: E401 Multiple imports on one line

* fix: E999 SyntaxError: Unexpected token 'json'

* fix: F821 Undefined name `unicode` by removing python2 compatibility

* fix: F811 Redefinition of unused `gtid` from line 3

* fix: E721 Do not compare types, use `isinstance()`

* fix: E721 Do not compare types, use `isinstance()`

* fix: F811 Redefinition of unused `TestMariadbBinlogStreamReader` from line 1012 by rename into TestMariadbBinlogStreamReader2

* fix: import json

* fix: fromtimestamp into utcfromtimestamp

* fix: apply black formatter

* fix: test that doesn't work

* fix: remove actions dependencies

* fix: E712

* fix: apply black

* fix: apply black

* fix: remove duplicated if-statement

* fix: indent for if-statement

Author: soulee-dev

.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+name: Lint
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x' # This will install the latest version of Python 3
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff black
+
+      - name: Run lint script
+        run: bash scripts/lint.sh

.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: trailing-whitespace
+    -   id: end-of-file-fixer
+    -   id: check-yaml
+    -   id: check-added-large-files
+
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.0.286
+    hooks:
+    -   id: ruff
+        args: [ --fix, --exit-non-zero-on-fix ]
+
+-   repo: https://github.com/psf/black
+    rev: 23.7.0
+    hooks:
+    -   id: black

CONTRIBUTING.md

@@ -0,0 +1,51 @@
+# Contributing to python-mysql-replication
+
+Firstly, thank you for considering to contribute to `python-mysql-replication`. We appreciate your effort, and to ensure that your contributions align with the project's coding standards, we employ the use of `pre-commit` hooks. This guide will walk you through setting them up.
+
+## Setting up pre-commit
+
+1. **Install pre-commit**
+
+   Before you can use `pre-commit`, you need to install it. You can do so using `pip`:
+
+   ```bash
+   pip install pre-commit
+   ```
+
+2. **Install the pre-commit hooks**
+
+   Navigate to the root directory of your cloned `python-mysql-replication` repository and run:
+
+   ```bash
+   pre-commit install
+   ```
+
+   This will install the `pre-commit` hooks to your local repository.
+
+3. **Make sure to stage your changes**
+
+   `pre-commit` will only check the files that are staged in git. So make sure to `git add` any new changes you made before running `pre-commit`.
+
+4. **Run pre-commit manually (Optional)**
+
+   Before committing, you can manually run:
+
+   ```bash
+   pre-commit run --all-files
+   ```
+
+   This will run the hooks on all the files. If there's any issue, the hooks will let you know.
+
+## If you encounter issues
+
+If you run into any problems with the hooks, you can always skip them using:
+
+```bash
+git commit -m "Your commit message" --no-verify
+```
+
+However, please note that skipping hooks might lead to CI failures if we use these checks in our CI pipeline. It's always recommended to adhere to the checks to ensure a smooth contribution process.
+
+---
+
+That's it! With these steps, you should be well on your way to contributing to `python-mysql-replication`. We look forward to your contributions!