Contributing

Author: brentjanderson

.tool-versions

@@ -0,0 +1 @@
+python 3.11.3

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing
+
+## Getting Started
+
+1. Install [asdf](https://asdf-vm.com)
+2. Install the asdf Python plugin
+
+```bash
+asdf plugin add python https://github.com/danhper/asdf-python.git # Visit that repository to see installation prerequisites
+```
+
+3. Run `asdf install` to install the version of Python specified in the [.tool-versions](.tool-versions) file
+4. Run `pip install -r requirements.txt` to install the Python dependencies
+
+## Running the tests
+
+```bash
+python -m pytest
+```
+
+## Running the linter
+
+```bash
+flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+```

knockapi/client.py

@@ -18,7 +18,7 @@ def request(self, method, endpoint, payload=None, options={}):
         url = '{}/v1{}'.format(self.host, endpoint)
 
         extra_headers = {}
-        if (method in ["post", "put"]) and options.get('idempotency_key') != None:
+        if (method in ["post", "put"]) and options.get('idempotency_key') is not None:
             extra_headers['Idempotency-Key'] = options.get('idempotency_key')
 
         r = requests.request(

knockapi/resources/messages.py

@@ -1,6 +1,7 @@
 import json
 from .service import Service
 
+
 class Messages(Service):
     def list(self, options=None):
         """

requirements.txt

@@ -0,0 +1,3 @@
+requests
+flake8
+pytest

tests/test_workflows_class.py

@@ -4,15 +4,22 @@
 
 # Tests
 
+
 def test_trigger():
     mocked_client = Mock()
     workflows = Workflows(mocked_client)
-    workflows.trigger("workflow-key", ["user-123"], {"foo": "bar"}, actor="actor-123", cancellation_key="cancel-key", tenant="tenant-123", options={"idempotency_key": "123"})
+    workflows.trigger(
+        "workflow-key",
+        ["user-123"],
+        {"foo": "bar"},
+        actor="actor-123",
+        cancellation_key="cancel-key",
+        tenant="tenant-123",
+        options={"idempotency_key": "123"})
     mocked_client.request.assert_called_with("post", "/workflows/workflow-key/trigger", payload={
         "actor": "actor-123",
         "recipients": ["user-123"],
         "data": {"foo": "bar"},
         "cancellation_key": "cancel-key",
         "tenant": "tenant-123"},
         options={'idempotency_key': '123'})
-