Merge pull request #7 from LEQO-Framework/main

Merge to upstream

Author: GeorgDaniel

.flake8

@@ -7,8 +7,8 @@ exclude =
     build,
     dist
 max-line-length = 140
-max-doc-length = 80
-max-complexity = 10
+max-doc-length = 120
+max-complexity = 12
 docstring-convention=google
 select=C,E,F,W,B,B902
-extend-ignore = E203
+extend-ignore = E203, W503

.github/workflows/ci-cd.yml

@@ -1,4 +1,4 @@
-name: Build and Push Docker Image
+name: Build and Publish BloqCat Docker Image
 
 on:
   push:
@@ -9,22 +9,35 @@ jobs:
   build-and-push:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+      # Step 1: Checkout the repository code
+      - name: Checkout code
+        uses: actions/checkout@v3
 
-    - name: Set up Docker Buildx
-      uses: docker/setup-buildx-action@v1
+      # Step 2: Set up Docker Buildx
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
 
-    - name: Log in to GitHub Container Registry
-      uses: docker/login-action@v1
-      with:
-        registry: ghcr.io
-        username: ${{ github.actor }}
-        password: ${{ secrets.GHCR_PAT }}
+      # Step 3: Log in to GHCR
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
 
-    - name: Build and push
-      uses: docker/build-push-action@v2
-      with:
-        context: .
-        file: ./Dockerfile
-        push: true
-        tags: ghcr.io/aldekal/bloqcat:latest
+      # Step 4: Build and push the Docker image
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v2
+        with:
+          context: .
+          file: ./Dockerfile
+          push: true
+          tags: ghcr.io/${{ github.repository_owner }}/bloqcat:latest
+
+      # Step 5: Make the image public
+      - name: Set public visibility for GHCR image
+        run: |
+          gh api -X PATCH \
+            /user/packages/container/bloqcat/visibility \
+            -F visibility=public \
+            -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}"

.github/workflows/lint_format.yml

@@ -0,0 +1,20 @@
+name: Formatting and linting
+
+on: [push]
+
+jobs:
+  check-formatting-and-linting:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.11.0
+      - name: Install black and flake8
+        run: python -m pip install black flake8
+      - name: Run flake8
+        run: flake8
+      - name: Run black
+        run: black --check --verbose --extend-exclude=".resources." .

Dockerfile

@@ -5,7 +5,8 @@ FROM python:3.9-slim
 WORKDIR /app
 
 # Copy the pyproject.toml and poetry.lock files to the container
-COPY pyproject.toml poetry.lock /app/
+COPY pyproject.toml poetry.lock README.md /app/
+COPY bloqcat /app/bloqcat
 
 ENV PATH="/root/.local/bin:${PATH}"
 

bloqcat/__init__.py

@@ -133,4 +133,3 @@ def create_app(test_config: Optional[Dict[str, Any]] = None):
 @click.group(cls=FlaskGroup, create_app=create_app)
 def cli():
     """Cli entry point for autodoc tooling."""
-    pass

bloqcat/api/__init__.py

@@ -32,7 +32,8 @@ class VersionsRootSchema(MaBaseSchema):
 class RootView(MethodView):
     @ROOT_ENDPOINT.response(HTTPStatus.OK, VersionsRootSchema())
     def get(self) -> Dict[str, str]:
-        """Get the Root API information containing the links to all versions of this api."""
+        """Get the Root API information containing the links to all versions of this
+        api."""
         return {
             "title": ROOT_API.spec.title,
             "v1": url_for("api-v1.RootView", _external=True),

bloqcat/api/jwt.py

@@ -44,7 +44,7 @@
 
 
 class JWTMixin:
-    """Extend Blueprint to add security documentation and jwt handling"""
+    """Extend Blueprint to add security documentation and jwt handling."""
 
     def require_jwt(
         self,
@@ -54,12 +54,12 @@ def require_jwt(
         optional: bool = False,
         refresh_token: bool = False,
     ) -> Callable[[Callable[..., RT]], Callable[..., RT]]:
-        """Decorator validating jwt tokens and documenting them for openapi specification (only version 3...)."""
+        """Decorator validating jwt tokens and documenting them for openapi specification
+        (only version 3...)."""
         if isinstance(security_scheme, str):
             security_scheme = {security_scheme: []}
 
         def decorator(func: Callable[..., RT]) -> Callable[..., RT]:
-
             # map to names that are less likely to have collisions with user defined arguments!
             _jwt_optional = optional
             _jwt_fresh = fresh

bloqcat/api/util.py

@@ -1,4 +1,5 @@
 """Module containing utilities for flask smorest APIs."""
+
 from typing import Any
 from .jwt import JWTMixin
 from flask_smorest import Blueprint

bloqcat/api/v1_api/auth.py

@@ -62,8 +62,8 @@ class LoginView(MethodView):
     def post(self, credentials: Dict[str, str]):
         """Login with the user credentials to receive a access and refresh token pair.
 
-        The access token can be used for all authorized api endpoints.
-        The refresh token can only be used with the refresh endpoint to get a new access token.
+        The access token can be used for all authorized api endpoints. The refresh token
+        can only be used with the refresh endpoint to get a new access token.
         """
         identity = DemoUser(credentials.get("username", "guest"))
         return LoginTokensData(