Directory import fix

Author: TCA166

Diff for: README.md

@@ -31,6 +31,10 @@ However due to the open ended nature of the blueprint this behavior can be easil
         pip install -r gitWebhook/requirements.txt
         ```
 
+    While installing the pip package functions as any other package the thing with this repo folder is that it functions like a local package.
+    That means that cloning this repo into your project folder will allow you to import ```gitWebhook``` as if it was installed via pip.
+    Same applies with adding as submodule with the added benefit of git understanding what is going on better,
+
 3. Create an instance of ```webhookBlueprint``` (or either of it's subclasses) with your settings
 
     ```python3

Diff for: __init__.py

@@ -1,5 +1,5 @@
 """Locally defined gitWebhook module."""
 
-from gitWebhook import *
+from .gitWebhook import webhookBlueprint, gitWebhookBlueprintABC, pullerWebhookBlueprint, functionWebhookBlueprint
 
 __all__ = ["webhookBlueprint", "gitWebhookBlueprintABC", "pullerWebhookBlueprint", "functionWebhookBlueprint"]

Diff for: gitWebhook/__init__.py

@@ -1,8 +1,8 @@
 """Python module providing Flask blueprints for handling GitHub and GitLab webhooks."""
 
-from gitWebhook.webhook import webhookBlueprint
-from gitWebhook.abstractWebhook import gitWebhookBlueprintABC
-from gitWebhook.pullerWebhook import pullerWebhookBlueprint
-from gitWebhook.functionWebhook import functionWebhookBlueprint
+from .webhook import webhookBlueprint
+from .abstractWebhook import gitWebhookBlueprintABC
+from .pullerWebhook import pullerWebhookBlueprint
+from .functionWebhook import functionWebhookBlueprint
 
 __all__ = ["webhookBlueprint", "gitWebhookBlueprintABC", "pullerWebhookBlueprint", "functionWebhookBlueprint"]

Diff for: gitWebhook/functionWebhook.py

@@ -1,11 +1,13 @@
-from gitWebhook.webhook import webhookBlueprint
+from .webhook import webhookBlueprint
 from typing import Callable, Any
 
 class functionWebhookBlueprint(webhookBlueprint):
     """A subclass of webhookBlueprint that processes the webhook data using a list of functions. The functions should return True if the webhook data is valid, and False otherwise. If the function returns a string, it will be included in the output."""
+    
     def __init__(self, webhookToken: str | None, functions: list[Callable[[dict[str, Any]], bool | str]], *args, **kwargs):
         super().__init__(webhookToken, *args, **kwargs)
         self.functions = functions
+        
     def processWebhook(self, data: dict[str, Any]) -> tuple[int, str]:
         if self.log is not None:
             self.log.debug(f"Processing webhook: {data}")
@@ -30,4 +32,3 @@ def processWebhook(self, data: dict[str, Any]) -> tuple[int, str]:
                     self.log.error(f"Function {function.__name__} returned an invalid type")
                 return 500, f"Function {function.__name__} returned an invalid type"
         return 200, str(output)
-

Diff for: gitWebhook/pullerWebhook.py

@@ -1,19 +1,21 @@
 from logging import Logger
 from typing import Any
 from unittest import TestSuite
-from gitWebhook.webhook import webhookBlueprint
+from .webhook import webhookBlueprint
 from subprocess import run
 from unittest import TestSuite, TestResult
 
 class pullerWebhookBlueprint(webhookBlueprint):
     """A subclass of webhookBlueprint that processes the webhook data by pulling from a git repository and running tests."""
+    
     def __init__(self, webhookToken: str | None, tests: TestSuite | None = None, log: Logger | None = None, name: str = "webhook", gitCommand: str = "/usr/bin/git", commandEnv: dict[str, str] | None = None, *args, **kwargs):
         super().__init__(webhookToken, log, name, *args, **kwargs)
         self.tests = tests
         self.gitCommand = gitCommand
         if commandEnv is None:
             commandEnv = dict(GIT_SSH_COMMAND="/usr/bin/ssh")
         self.commandEnv = commandEnv
+    
     def processWebhook(self, data: dict[str, Any]) -> tuple[int, str]:
         if self.log is not None:
             self.log.debug(f"Processing webhook: {data}")

Diff for: gitWebhook/webhook.py

@@ -3,7 +3,7 @@
 from hmac import new as hmacNew
 from typing import Any
 from logging import Logger
-from gitWebhook.abstractWebhook import gitWebhookBlueprintABC
+from .abstractWebhook import gitWebhookBlueprintABC
 
 GITHUB_HEADER = "X-Hub-Signature-256"
 
@@ -24,6 +24,7 @@ def verifyGitlabRequest(request: Request, token:str) -> bool:
 
 class webhookBlueprint(Blueprint, gitWebhookBlueprintABC):
     """Wrapper over the flask blueprint that creates an endpoint for receiving and processing git webhooks. Overwrite the processWebhook method to process the webhook data."""
+    
     def __init__(self, webhookToken:str | None, log:Logger | None = None, name:str="webhook", *args, **kwargs):
         super().__init__(name, self.__class__.__name__, *args, **kwargs)
         self.log = log
@@ -32,6 +33,7 @@ def __init__(self, webhookToken:str | None, log:Logger | None = None, name:str="
                 self.log.warning("No webhook token provided. THIS IS VERY UNSAFE")
         self.webhookToken = webhookToken
         self.route("/", methods=["POST"])(self.receiveWebhook)
+    
     def receiveWebhook(self) -> Response:
         """Receive webhook from GitHub and process it using the processWebhook method."""
         if self.log is not None:
@@ -67,6 +69,7 @@ def receiveWebhook(self) -> Response:
         if self.log is not None:
             self.log.info(f"Webhook processed with status code {ret[0]} and message: {ret[1]}")
         return Response(ret[1], status=ret[0])
+    
     def processWebhook(self, data:dict[str, Any]) -> tuple[int, str]:
         """Process the webhook. Return a tuple of (status code, message)"""
         return (200, "OK")