Organize

Author: mana-ysh

.flake8

@@ -0,0 +1,6 @@
+[flake8]
+max-line-length = 100
+# mccabe
+max-complexity = 10
+ignore =
+ # E203 # whitespace before :

Dockerfile

@@ -0,0 +1,22 @@
+FROM python:3.7-slim-buster
+
+ENV PYTHONIOENCODING UTF-8
+ENV LC_ALL C.UTF-8
+ENV LANG C.UTF-8
+
+RUN apt-get update && \
+ apt-get install -y \
+ make \
+ curl
+
+COPY . /app
+
+WORKDIR /app
+
+# update to avoid 'setup.py' not found error
+# RUN pip3 install -U pip
+RUN pip3 install .
+
+RUN rm -rf /var/lib/apt/lists/*
+
+CMD [ "make", "launch" ]

Makefile

@@ -0,0 +1,47 @@
+
+##### docker
+IMAGE_NAME := python-api-template
+CONTAINER_NAME := ${IMAGE_NAME}-container
+SRC_PORT := 4600
+DST_PORT := 9876
+
+build-image:
+docker build -t ${IMAGE_NAME} ./
+
+run-container:
+docker run -it -d \
+--name ${CONTAINER_NAME} \
+-p ${SRC_PORT}:${DST_PORT} \
+${IMAGE_NAME}
+
+##### ci
+ci: typecheck test lint
+
+typecheck:
+@echo check types
+mypy ./ \
+--disallow-untyped-defs \
+--disallow-any-expr \
+--no-implicit-optional \
+--no-site-packages \
+
+lint:
+@echo check style
+flake8 --show-source --statistics
+
+test:
+@echo testing
+pytest -rf --cov=./
+
+
+##### application
+GUNICORN_CONFIG_PATH := config/gunicorn.py
+
+install:
+poetry install
+
+launch:
+gunicorn app:app -c ${GUNICORN_CONFIG_PATH}
+
+launch-develop:
+python app.py

README.md

@@ -0,0 +1 @@
+# python-api-template

app.py

@@ -0,0 +1,17 @@
+
+import os
+
+from python_api_template.controller import create_app
+
+
+app = create_app()
+
+
+if __name__ == "__main__":
+ # running with debugging purpose ** NOT for production **
+ port = int(os.environ["FLASK_APP_PORT"]) if "FLASK_APP_PORT" in os.environ else 5000
+ app.run(
+ host="0.0.0.0",
+ port=port,
+ debug=True
+ )

config/gunicorn.py

@@ -0,0 +1,4 @@
+import os
+
+bind = '0.0.0.0:{}'.format(str(os.getenv('GNICORN_APP_PORT', 9876)))
+workers = 1