Add pre-comit

.github/workflows/lint.yml

@@ -17,10 +17,10 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v2
 
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
 
       - name: Install dependencies
         run: |

.github/workflows/test.yml

@@ -17,10 +17,10 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v2
 
-      - name: Set up Python 3.8
+      - name: Set up Python 3.9
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
 
       - name: Install dependencies
         run: |
@@ -40,7 +40,7 @@ jobs:
           echo "DB_USER=$DB_USER" >> .env
           echo "DB_PASS=$DB_PASS" >> .env
           docker compose up --build -d
-          
+
           echo "Checking .env"
           cat .env
 
@@ -64,5 +64,3 @@ jobs:
 
       - name: Stop and remove container
         run: docker compose down
-
-

.gitignore

@@ -1,4 +1,4 @@
 .idea/
 __pycache__/
 
-.env
+.env

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.4.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/psf/black
+    rev: 24.8.0
+    hooks:
+    -   id: black
+        args: ["--line-length", "120"]
+-   repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.10.1
+    hooks:
+      - id: isort
+        args: ["--profile", "black"]
+-   repo: https://github.com/pylint-dev/pylint
+    rev: v3.2.6
+    hooks:
+      - id: pylint
+        language: system
+        args:
+          - "--ignore=alembic,__init__.py"
+          - "--max-line-length=120"
+          - "--disable=missing-docstring,no-member,missing-class-docstring,missing-function-docstring,missing-timeout,too-few-public-methods"
+-   repo: https://github.com/Yelp/detect-secrets
+    rev: v1.5.0
+    hooks:
+    -   id: detect-secrets
+        args: ['--baseline', '.secrets.baseline']
+        exclude: poetry.lock

.secrets.baseline

@@ -0,0 +1,137 @@
+{
+  "version": "1.5.0",
+  "plugins_used": [
+    {
+      "name": "ArtifactoryDetector"
+    },
+    {
+      "name": "AWSKeyDetector"
+    },
+    {
+      "name": "AzureStorageKeyDetector"
+    },
+    {
+      "name": "Base64HighEntropyString",
+      "limit": 4.5
+    },
+    {
+      "name": "BasicAuthDetector"
+    },
+    {
+      "name": "CloudantDetector"
+    },
+    {
+      "name": "DiscordBotTokenDetector"
+    },
+    {
+      "name": "GitHubTokenDetector"
+    },
+    {
+      "name": "GitLabTokenDetector"
+    },
+    {
+      "name": "HexHighEntropyString",
+      "limit": 3.0
+    },
+    {
+      "name": "IbmCloudIamDetector"
+    },
+    {
+      "name": "IbmCosHmacDetector"
+    },
+    {
+      "name": "IPPublicDetector"
+    },
+    {
+      "name": "JwtTokenDetector"
+    },
+    {
+      "name": "KeywordDetector",
+      "keyword_exclude": ""
+    },
+    {
+      "name": "MailchimpDetector"
+    },
+    {
+      "name": "NpmDetector"
+    },
+    {
+      "name": "OpenAIDetector"
+    },
+    {
+      "name": "PrivateKeyDetector"
+    },
+    {
+      "name": "PypiTokenDetector"
+    },
+    {
+      "name": "SendGridDetector"
+    },
+    {
+      "name": "SlackDetector"
+    },
+    {
+      "name": "SoftlayerDetector"
+    },
+    {
+      "name": "SquareOAuthDetector"
+    },
+    {
+      "name": "StripeDetector"
+    },
+    {
+      "name": "TelegramBotTokenDetector"
+    },
+    {
+      "name": "TwilioKeyDetector"
+    }
+  ],
+  "filters_used": [
+    {
+      "path": "detect_secrets.filters.allowlist.is_line_allowlisted"
+    },
+    {
+      "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies",
+      "min_level": 2
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_indirect_reference"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_likely_id_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_lock_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_potential_uuid"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_sequential_string"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_swagger_file"
+    },
+    {
+      "path": "detect_secrets.filters.heuristic.is_templated_secret"
+    }
+  ],
+  "results": {
+    "alembic.ini": [
+      {
+        "type": "Basic Auth Credentials",
+        "filename": "alembic.ini",
+        "hashed_secret": "9d4e1e23bd5b727046a9e3b4b7db57bd8d6ee684",
+        "is_verified": false,
+        "line_number": 63
+      }
+    ]
+  },
+  "generated_at": "2024-08-05T12:02:34Z"
+}

LICENSE

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

README.md

@@ -4,7 +4,7 @@ A simple Python project to get you started with web development and testing usin
 
 ## Prerequisites
 
-- Python 3.8
+- Python 3.9
 - Docker
 - Docker Compose
 - Poetry
@@ -42,11 +42,11 @@ DB_HOST=db
 DB_NAME=postgres
 DB_PORT=5432
 ```
-### Setup 
+### Setup
 #### Create a virtual environment and install the dependencies
 
 ```bash
-poetry shell 
+poetry shell
 ```
 
 #### Build the Docker image and run the containers
@@ -90,9 +90,15 @@ We are using following tools:
 
 If you want to lint every file using all at once you can also run `make lint`
 
+Beside that you can also use pre-commit.
+```
+pre-commit install
+pre-commit run --all-files
+```
+
 #### GitHub Actions
-This project uses GitHub Actions for CI. 
-The workflow is defined in `.github/workflows/main.yml`. 
+This project uses GitHub Actions for CI.
+The workflow is defined in `.github/workflows/main.yml`.
 It sets up a Python environment, installs the dependencies, runs Docker Compose, and runs the tests.
 The workflow is triggered on every push to the `main` branch.
 
@@ -103,4 +109,4 @@ To use GitHub Actions in your repository, you need to add secrets to your reposi
 - `DB_NAME`
 
 ## License
-This project is licensed under the terms of the MIT license. See the LICENSE file for details.
+This project is licensed under the terms of the MIT license. See the LICENSE file for details.

alembic/README

@@ -1 +1 @@
-Generic single-database configuration.
+Generic single-database configuration.