Bootstrap aiohttp project

Author: WH

Makefile

@@ -0,0 +1,7 @@
+.PHONY: test
+test:
+	pytest --cov=app
+
+.PHONY: testcov
+testcov:
+	pytest --cov=app && (echo "building coverage html, view at './htmlcov/index.html'"; coverage html)

README.md

@@ -1 +1,10 @@
-# aidbox-python-sdk
+aidbox-python-sdk
+=================
+
+
+1. Activate a python 3.6 environment `python3.6 -m venv env`
+2. Set env variables and activate virtual environment `source activate_settings.sh` 
+2. Install the required packages with `pip install -r requirements/base.txt -r requirements/dev.txt`
+3. Make sure the app's settings are configured correctly (see `activate_settings.sh` and `aidbox_python_sdk/settings.py`). You can also
+ use environment variables to define sensitive settings, eg. DB connection variables
+4. You can then run your app during development with `adev runserver`.

activate_settings.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+# App settings go here, they're validated in app.settings
+
+# the AIO_ env variables are used by `adev runserver` when serving your app for development
+export AIO_APP_PATH="aidbox_python_sdk/"
+
+
+# also activate the python virtualenv for convenience, you can remove this if you're python another way
+. env/bin/activate

aidbox_python_sdk/__init__.py

@@ -0,0 +1,3 @@
+"""
+aidbox-python-sdk
+"""

aidbox_python_sdk/gunicorn.py

@@ -0,0 +1,20 @@
+"""
+This file allows your to serve your application using gunicorn. gunicorn is not installed by default
+by the requirements file adev creates, you'll need to install it yourself and add it to requirements.txt.
+
+To run the aidbox_python_sdk using gunicorn, in the terminal run
+
+    pip install gunicorn
+    gunicorn aidbox_python_sdk.gunicorn:aidbox_python_sdk --worker-class aiohttp.worker.GunicornWebWorker
+
+You could use a variant of the above with heroku (in the `Procfile`) or with Docker in the ENTRYPOINT statement.
+"""
+import asyncio
+import uvloop
+
+from .main import create_app
+
+uvloop.install()
+loop = asyncio.get_event_loop()
+
+app = loop.run_until_complete(create_app())

aidbox_python_sdk/main.py

@@ -0,0 +1,26 @@
+from pathlib import Path
+
+from aiohttp import web
+
+from .settings import Settings
+from .views import index
+
+
+THIS_DIR = Path(__file__).parent
+BASE_DIR = THIS_DIR.parent
+
+
+def setup_routes(app):
+    app.router.add_get('/', index, name='index')
+
+
+async def create_app():
+    app = web.Application()
+    settings = Settings()
+    app.update(
+        name='aidbox-python-sdk',
+        settings=settings
+    )
+
+    setup_routes(app)
+    return app

aidbox_python_sdk/settings.py

@@ -0,0 +1,63 @@
+import os
+from pathlib import Path
+
+
+class Required:
+    def __init__(self, v_type=None):
+        self.v_type = v_type
+
+
+class Settings:
+    """
+    Any setting defined here can be overridden by:
+
+    Settings the appropriate environment variable, eg. to override FOOBAR, `export APP_FOOBAR="whatever"`.
+    This is useful in production for secrets you do not wish to save in code and
+    also plays nicely with docker(-compose). Settings will attempt to convert environment variables to match the
+    type of the value here. See also activate.settings.sh.
+
+    Or, passing the custom setting as a keyword argument when initialising settings (useful when testing)
+    """
+    _ENV_PREFIX = 'APP_'
+
+    def __init__(self, **custom_settings):
+        """
+        :param custom_settings: Custom settings to override defaults, only attributes already defined can be set.
+        """
+        self._custom_settings = custom_settings
+        self.substitute_environ()
+        for name, value in custom_settings.items():
+            if not hasattr(self, name):
+                raise TypeError('{} is not a valid setting name'.format(name))
+            setattr(self, name, value)
+        setattr(self, 'static_path', None)
+
+    def substitute_environ(self):
+        """
+        Substitute environment variables into settings.
+        """
+        for attr_name in dir(self):
+            if attr_name.startswith('_') or attr_name.upper() != attr_name:
+                continue
+
+            orig_value = getattr(self, attr_name)
+            is_required = isinstance(orig_value, Required)
+            orig_type = orig_value.v_type if is_required else type(orig_value)
+            env_var_name = self._ENV_PREFIX + attr_name
+            env_var = os.getenv(env_var_name, None)
+            if env_var is not None:
+                if issubclass(orig_type, bool):
+                    env_var = env_var.upper() in ('1', 'TRUE')
+                elif issubclass(orig_type, int):
+                    env_var = int(env_var)
+                elif issubclass(orig_type, Path):
+                    env_var = Path(env_var)
+                elif issubclass(orig_type, bytes):
+                    env_var = env_var.encode()
+                # could do floats here and lists etc via json
+                setattr(self, attr_name, env_var)
+            elif is_required and attr_name not in self._custom_settings:
+                raise RuntimeError('The required environment variable "{0}" is currently not set, '
+                                   'you\'ll need to run `source activate.settings.sh` '
+                                   'or you can set that single environment variable with '
+                                   '`export {0}="<value>"`'.format(env_var_name))

aidbox_python_sdk/views.py

@@ -0,0 +1,12 @@
+from aiohttp import web
+
+
+async def index(request):
+    """
+    This is the view handler for the "/" url.
+
+    :param request: the request object see http://aiohttp.readthedocs.io/en/stable/web_reference.html#request
+    :return: aiohttp.web.Response object
+    """
+
+    return web.json_response({'hello': 'world'})

requirements/base.txt

@@ -0,0 +1,5 @@
+# you will need to install these requirements with `pip install -r requirements.txt`
+aiohttp==3.4.4
+pytest-aiohttp==0.3.0
+pytest-cov==2.6.0
+pytest==4.0.1

requirements/dev.txt

@@ -0,0 +1,3 @@
+# you will need to install these requirements with `pip install -r requirements.txt`
+aiohttp-devtools==0.11
+uvloop==0.12.0

setup.cfg

@@ -0,0 +1,6 @@
+[tool:pytest]
+testpaths = tests
+
+[flake8]
+max-line-length = 120
+max-complexity = 12

tests/__init__.py

@@ -0,0 +1,3 @@
+"""
+aidbox-python-sdk tests
+"""