feat: initial commit with users and notify endpoints

Author: cjbell

.editorconfig

@@ -0,0 +1,5 @@
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true

.gitignore

@@ -0,0 +1,110 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+.DS_Store
+
+# Pipenv
+Pipfile
+Pipfile.lock
+.vscode/launch.json

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Knock Labs, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+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.

README.md

@@ -0,0 +1,31 @@
+# Knock Python library
+
+Knock API access for applications written in Python.
+
+## Documentation
+
+See the [documentation](https://docs.knock.app) for Python usage examples.
+
+## Installation
+
+To install from PyPi, run the following:
+
+```bash
+pip install knock-py
+```
+
+To install from source, clone the repo and run the following:
+
+```bash
+python setup.py install
+```
+
+## Configuration
+
+To use the library you must provide a secret API key, provided in the Knock dashboard.
+
+```python
+import knock
+
+knock.api_key = "sk_12345"
+```

knockapi/__init__.py

@@ -0,0 +1,2 @@
+from knockapi.client import Knock
+from knockapi.resources import *

knockapi/client.py

@@ -0,0 +1,65 @@
+import requests
+
+__version__ = '0.1.0'
+
+
+class Connection(object):
+    def __init__(self, api_key, host='https://api.knock.app'):
+        self.api_key = api_key
+        self.host = host
+        self.client_version = __version__
+        self.headers = {
+            'Authorization': 'Bearer {}'.format(self.api_key),
+            'User-Agent': 'Knock Python - {}'.format(self.client_version)
+        }
+
+    def request(self, method, endpoint, payload=None):
+        url = '{}/v1{}'.format(self.host, endpoint)
+
+        r = requests.request(
+            method,
+            url,
+            json=payload,
+            headers=self.headers,
+        )
+
+        if r.ok:
+            return r.json()
+        return r.raise_for_status()
+
+
+class Knock(Connection):
+    """Client to access the Knock features."""
+    @property
+    def _auth(self):
+        return self.api_key
+
+    @property
+    def _version(self):
+        return __version__
+
+    @property
+    def users(self):
+        from .resources import User
+        return User(self)
+
+    def notify(self, name, actor, recipients, data={}):
+        """
+        Triggers a notification workflow.
+
+        Args:
+            name (str): The name of the notification to invoke.
+            actor (str): The ID of the actor performing this action.
+            recipients (array): An array of user IDs of who should be notified.
+            data (dict): Any data to be passed to the notify call.
+
+        Returns:
+            dict: Response from Knock.
+        """
+        params = {
+            'name': name,
+            'actor': actor,
+            'recipients': recipients,
+            'data': data
+        }
+        return self.request("post", "/notify", payload=params)

knockapi/resources/__init__.py

@@ -0,0 +1 @@
+from .users import User

knockapi/resources/service.py

@@ -0,0 +1,3 @@
+class Service(object):
+    def __init__(self, client):
+        self.client = client

knockapi/resources/users.py

@@ -0,0 +1,30 @@
+from .service import Service
+
+
+class User(Service):
+    def get_user(self, id):
+        """
+        Get a user by their id
+
+        Args:
+            id: The users ID
+
+        Returns:
+            dict: User response from Knock.
+        """
+        endpoint = '/users/{}'.format(id)
+        return self.client.request('get', endpoint)
+
+    def identify(self, id, data={}):
+        """
+        Identify a user, upserting them
+
+        Args:
+            id (str): The users ID
+            data (dict): Other properties to put on the user
+
+        Returns:
+            dict: User response from Knock.
+        """
+        endpoint = '/users/{}'.format(id)
+        return self.client.request('put', endpoint, payload=data)

setup.py

@@ -0,0 +1,47 @@
+import sys
+import os
+import setuptools
+
+from setuptools.command.install import install
+
+version = '0.1.0'
+
+with open("README.md", "r") as f:
+    long_description = f.read()
+
+setuptools.setup(
+    name='knockapi',
+    version=version,
+    python_requires='>=2.7.16, <4',
+    install_requires=[
+        'requests',
+        'importlib-metadata ~= 1.0 ; python_version < "3.8"'
+    ],
+    extras_require={
+        'dev': [
+            'bump2version',
+        ]
+    },
+    classifiers=[
+        'Development Status :: 5 - Production/Stable',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Libraries',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
+        'Programming Language :: Python :: 3',
+        'Programming Language :: Python :: 3.5',
+        'Programming Language :: Python :: 3.6',
+        'Programming Language :: Python :: 3.7',
+        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+    ],
+    description='Client library for the Knock API',
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    url='https://github.com/knocklabs/knock-python',
+    packages=setuptools.find_packages(),
+    author='Knock Labs, Inc.',
+    author_email='[email protected]',
+    license='MIT'
+)