[MZ] Created app template

Author: manuelzander

.gitignore

@@ -127,3 +127,6 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+# Manuel's additions
+.vscode/

Dockerfile

@@ -0,0 +1,16 @@
+FROM python:3.7-alpine
+
+RUN apk update && apk add bash make automake gcc g++ subversion python3-dev
+
+# We copy just the requirements.txt first to leverage cache
+COPY ./requirements.txt /app/requirements.txt
+
+WORKDIR /app
+
+RUN python3 -m pip install -r requirements.txt
+
+COPY . /app
+
+EXPOSE 3001
+
+CMD ["python3", "src/app.py"]

Makefile

@@ -0,0 +1,18 @@
+all: sort-imports format type-check test
+
+.PHONY: sort-imports format type-check test
+
+SHELL=/bin/bash
+SHELLFLAGS=-euo pipefail -c
+
+sort-imports:
+	python3 -m isort --atomic app tests
+
+format:
+	python3 -m black app tests
+
+type-check:
+	python3 -m mypy app
+
+test:
+	python3 -m pytest -o log_cli=true tests

README.md

@@ -1 +1,61 @@
-# zoe_challenge
+# zoe_challenge
+
+## Prerequisites
+
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
+
+The code is run and tested with Python 3.7.7 on macOS 10.14.6.
+
+### Environment
+
+Clone the repo to your local machine.
+
+Create a virtual environment for Python 3 with:
+
+    python3 -m pip install virtualenv
+    python3 -m virtualenv -p python3 env
+
+Activate the virtual environment with:
+
+    source env/bin/activate
+
+Install the required Python packages with:
+
+    pip3 install -r requirements.txt
+
+
+## Run the app
+
+The `Dockerfile` can be used to build an image and deploy it locally:
+Make sure you have Docker installed:
+
+    docker -v
+    
+Build the image with:
+
+    docker build --tag emoji-app:latest .
+    
+Run the container locally:
+    
+    docker run --name emoji-app:latest -p 3001:3001 app
+    
+You can now trigger the endpoint (`localhost:3001`), for example using `nc`.
+
+<!-- TODO -->
+<!-- Include usage info -->
+
+## Development and testing
+
+Use the `Makefile` you can run `make <cmd>` where `<cmd>` is one of:
+
+* `sort-imports` to ensure Python imports are in the correct PEP format
+* `format` to format Python files using black
+* `type-check` to run `mypy` static type checking
+* `test` to run unittests using `pytest`
+* `all` to run all the above steps
+
+or just type `make`/`make all`, which will run all of the above.
+
+## Authors
+
+* Manuel Zander

app/app.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python
+
+import logging
+
+import coloredlogs
+
+logger = logging.getLogger(__name__)
+coloredlogs.install(level="INFO")

app/config.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python
+
+import logging
+
+import coloredlogs
+
+logger = logging.getLogger(__name__)
+coloredlogs.install(level="INFO")

app/utils.py

@@ -0,0 +1,8 @@
+#!/usr/bin/env python
+
+import logging
+
+import coloredlogs
+
+logger = logging.getLogger(__name__)
+coloredlogs.install(level="INFO")

mypy.ini

@@ -0,0 +1,11 @@
+[mypy]
+python_version = 3.7
+
+warn_return_any = True
+warn_unreachable = True
+warn_unused_ignores = True
+warn_unused_configs = True
+
+disallow_untyped_defs = True
+
+ignore_missing_imports = True

requirements.txt

@@ -0,0 +1,24 @@
+appdirs==1.4.4
+attrs==19.3.0
+black==19.10b0
+click==7.1.2
+coloredlogs==14.0
+humanfriendly==8.2
+importlib-metadata==1.7.0
+isort==5.0.9
+more-itertools==8.4.0
+mypy==0.782
+mypy-extensions==0.4.3
+packaging==20.4
+pathspec==0.8.0
+pluggy==0.13.1
+py==1.9.0
+pyparsing==2.4.7
+pytest==5.4.3
+regex==2020.6.8
+six==1.15.0
+toml==0.10.1
+typed-ast==1.4.1
+typing-extensions==3.7.4.2
+wcwidth==0.2.5
+zipp==3.1.0

tests/test_app.py

@@ -0,0 +1,20 @@
+import os
+import unittest
+from pathlib import Path
+
+ROOT_DIR = Path(os.path.dirname(os.path.abspath(__file__))).parent
+
+
+class AppTestCase(unittest.TestCase):
+    def setUp(self) -> None:
+        pass
+
+    def test_manuel(self):
+        self.assertEqual(True, True)
+
+    def tearDown(self) -> None:
+        pass
+
+
+if __name__ == "__main__":
+    unittest.main()