Chore: updated repo to current InvenHost defaults (#3)

* updated repo to current InvenHost defaults

* style fixes

Author: matmair

.github/FUNDING.yml

@@ -9,5 +9,7 @@ on:
 
 jobs:
   plugin-action:
-    uses: matmair/inventree-meta-plugin/.github/workflows/plugin_action.yaml@main
-    secrets: inherit
+    name: CI
+    uses: matmair/inventree-meta-plugin/.github/workflows/plugin_action.yaml@next
+    secrets:
+      PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/action.yaml

@@ -0,0 +1,20 @@
+exclude: .*/(static|migrations|locale)/.*
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+    - id: trailing-whitespace
+    - id: end-of-file-fixer
+    - id: check-yaml
+    - id: check-added-large-files
+    - id: mixed-line-ending
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.11
+    hooks:
+    - id: ruff
+      args: [--fix]
+    - id: ruff-format
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.2.6
+    hooks:
+    - id: codespell

.pre-commit-config.yaml

@@ -1,2 +1,2 @@
 include LICENSE
-include README.md
+include README.md

MANIFEST.in

@@ -12,7 +12,7 @@ Enable the plugin in the plugin settings. You need to be signed in as a superuse
 **The server will restart if you enable the plugin**
 
 3. Migrate
-Access your instances python enviroment and run
+Access your instances python environment and run
 
 ```bash
 inv migrate

README.md

@@ -10,7 +10,7 @@ readme = "README.md"
 license = {text = "MIT"}
 keywords = ["inventree", "inventree-plugin", "zapier", "inventory",]
 authors = [
-    {name = "Matthias J Mair", email =  "code@mjmair.com"}
+    {name = "Matthias Mair", email =  "code@mjmair.com"}
 ]
 classifiers=[
     "Programming Language :: Python :: 3",
@@ -30,11 +30,32 @@ dependencies = ['django',]
 dev = ['twine', 'setuptools']
 
 [project.urls]
-repository = "https://github.com/matmair/inventree-zapier"
-"Bug Tracker" = "https://github.com/matmair/inventree-zapier/issues"
+"Repository" = "https://github.com/invenhost/inventree-zapier"
+"Bug Tracker" = "https://github.com/invenhost/inventree-zapier/issues"
 
 [project.entry-points."inventree_plugins"]
 inventree-zapier = "inventree_zapier:ZapierPlugin"
 
 [tool.setuptools.packages.find]
-where = ["src"]
+where = ["src"]
+
+[tool.ruff]
+exclude=[".git","__pycache__","dist","build","test.py","tests", "venv","env",".venv",".env"]
+
+[tool.ruff.lint]
+select = ["A", "B", "C4", "D", "DJ", "N", "I","S"]
+ignore = ["N999", ]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+section-order = ["future", "standard-library", "django", "third-party", "first-party", "local-folder" ]
+known-first-party = ["src", "plugin", "InvenTree", "common"]
+
+[tool.ruff.lint.isort.sections]
+"django" = ["django"]
+
+[tool.check-wheel-contents]
+ignore = ['W004']

pyproject.toml

@@ -1,6 +1,4 @@
-"""
-Plugin to integrate Zapier into InvenTree.
-"""
+"""Plugin to integrate Zapier into InvenTree."""
 
 import json
 
@@ -10,10 +8,11 @@
 
 # InvenTree plugin libs
 from plugin import InvenTreePlugin
-from plugin.mixins import UrlsMixin, APICallMixin, AppMixin, EventMixin
+from plugin.mixins import APICallMixin, AppMixin, EventMixin, UrlsMixin
 
 
 class ZapierPlugin(AppMixin, APICallMixin, EventMixin, UrlsMixin, InvenTreePlugin):
+    """Integrate Zapier into InvenTree."""
 
     AUTHOR = "Matthias Mair"
     DESCRIPTION = "Zapier plugin for InvenTree"
@@ -23,44 +22,62 @@ class ZapierPlugin(AppMixin, APICallMixin, EventMixin, UrlsMixin, InvenTreePlugi
     TITLE = "Zapier connector for InvenTree"
 
     def view_connection_test(self, request):
-        """for testing the connection"""
-        return JsonResponse({'user': request.user.username}, safe=False)
+        """For testing the connection."""
+        return JsonResponse({"user": request.user.username}, safe=False)
 
     @csrf_exempt
     def view_event_reg(self, request):
-        """register a hook"""
+        """Register a hook."""
         from .models import ZapierHook
 
         ZapierHook.objects.create(hookurl=self.get_hookurl(request))
-        return JsonResponse({'response': 'ok'})
+        return JsonResponse({"response": "ok"})
 
     def get_hookurl(self, request):
-        ret = json.loads(str(request.body, 'utf-8'))
-        return ret.get('hookUrl')
+        """Get the hookurl from the request."""
+        ret = json.loads(str(request.body, "utf-8"))
+        return ret.get("hookUrl")
 
     @csrf_exempt
     def view_event_unsub(self, request):
-        """unregister a hook"""
+        """Unregister a hook."""
         from .models import ZapierHook
 
         obj = ZapierHook.objects.filter(hookurl=self.get_hookurl(request))
         if obj:
             obj.delete()
-            return JsonResponse({'response': 'ok. Hook deleted'})
-        return JsonResponse({'response': 'Hook not found'})
+            return JsonResponse({"response": "ok. Hook deleted"})
+        return JsonResponse({"response": "Hook not found"})
 
     def view_event_list(self, request):
-        """for getting a sample list"""
-        return JsonResponse([
-            {'event': 'instance.created', 'id': 1, 'model': 'Part', 'table': 'part.Part', 'args': '', 'kwargs': ''},
-            {'event': 'instance.saved', 'id': 1, 'model': 'Part', 'table': 'part.Part', 'args': '', 'kwargs': ''}
-        ], safe=False)
+        """For getting a sample list."""
+        return JsonResponse(
+            [
+                {
+                    "event": "instance.created",
+                    "id": 1,
+                    "model": "Part",
+                    "table": "part.Part",
+                    "args": "",
+                    "kwargs": "",
+                },
+                {
+                    "event": "instance.saved",
+                    "id": 1,
+                    "model": "Part",
+                    "table": "part.Part",
+                    "args": "",
+                    "kwargs": "",
+                },
+            ],
+            safe=False,
+        )
 
     def process_event(self, event, *args, **kwargs):
-        """ Custom event processing """
+        """Custom event processing."""
         from .models import ZapierHook
 
-        if kwargs.get('model') == 'ZapierHook':
+        if kwargs.get("model") == "ZapierHook":
             return
 
         obj = ZapierHook.objects.all()
@@ -70,22 +87,23 @@ def process_event(self, event, *args, **kwargs):
                     item.hookurl,
                     endpoint_is_url=True,
                     simple_response=False,
-                    method='POST',
+                    method="POST",
                     data={
-                        'event': event,
-                        'model': str(kwargs.get('model', '')),
-                        'table': str(kwargs.get('table', '')),
-                        'id': str(kwargs.get('id', '')),
-                        'args': str(args),
-                        'kwargs': str(kwargs)
-                    }
+                        "event": event,
+                        "model": str(kwargs.get("model", "")),
+                        "table": str(kwargs.get("table", "")),
+                        "id": str(kwargs.get("id", "")),
+                        "args": str(args),
+                        "kwargs": str(kwargs),
+                    },
                 )
                 print(ret)
 
     def setup_urls(self):
+        """URLs for app."""
         return [
-            path(r'^test/', self.view_connection_test, name='test'),
-            path(r'^event/register/', self.view_event_reg, name='event-register'),
-            path(r'^event/unsub/', self.view_event_unsub, name='event-unsub'),
-            path(r'^event/list/', self.view_event_list, name='event-list'),
+            path(r"^test/", self.view_connection_test, name="test"),
+            path(r"^event/register/", self.view_event_reg, name="event-register"),
+            path(r"^event/unsub/", self.view_event_unsub, name="event-unsub"),
+            path(r"^event/list/", self.view_event_list, name="event-list"),
         ]

setup.cfg

@@ -2,4 +2,6 @@
 
 from .ZapierPlugin import ZapierPlugin
 
-__all__ = [ZapierPlugin, ]
+__all__ = [
+    ZapierPlugin,
+]

src/inventree_zapier/ZapierPlugin.py

@@ -1,14 +1,29 @@
+"""Models for ZapierPlugin."""
 from django.db import models
 
 
 class EventRegistration(models.Model):
-    """Keeps a list of all registered events"""
+    """Keeps a list of all registered events."""
 
-    event = models.CharField(max_length=250, )
-    model = models.CharField(max_length=250, )
+    event = models.CharField(
+        max_length=250,
+    )
+    model = models.CharField(
+        max_length=250,
+    )
+
+    def __str__(self):
+        """Get string representation of event."""
+        return str(self.event)
 
 
 class ZapierHook(models.Model):
-    """Keeps a list of all registered zaier callback hooks"""
+    """Keeps a list of all registered zaier callback hooks."""
+
+    hookurl = models.CharField(
+        max_length=250,
+    )
 
-    hookurl = models.CharField(max_length=250, )
+    def __str__(self):
+        """Get string representation of hook."""
+        return str(self.hookurl)