Add Docker and GitHub Actions (#3)

Author: brendanator

README.md

@@ -9,6 +9,8 @@ Best practices [cookiecutter](https://github.com/audreyr/cookiecutter) template
 - Static typing with [mypy](http://mypy-lang.org/)
 - Linting with [flake8](http://flake8.pycqa.org/en/latest/)
 - Git hooks that run all the above with [pre-commit](https://pre-commit.com/)
+- Deployment ready with [Docker](https://docker.com/)
+- Continuous Integration with [GitHub Actions](https://github.com/features/actions)
 
 ## Quickstart
 ```sh

cookiecutter.json

@@ -1,4 +1,5 @@
 {
   "project_name": "Best Practices",
-  "repo_name": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}"
+  "repo_name": "{{ cookiecutter.project_name.lower().replace(' ', '_').replace('-', '_') }}",
+  "docker": "y"
 }

hooks/post_gen_project.py

@@ -1,12 +1,41 @@
+import os
 import sys
 
-python_version = str(sys.version_info.major) + '.' + str(sys.version_info.minor)
 
+def set_python_version():
+    python_version = str(sys.version_info.major) + "." + str(sys.version_info.minor)
 
-with open('Pipfile') as f:
-    pipfile = f.read()
-    pipfile = pipfile.replace(r'{python_version}', python_version)
+    file_names = ["Dockerfile", "Pipfile", ".github/workflows/test.yml"]
+    for file_name in file_names:
+        with open(file_name) as f:
+            contents = f.read()
+            contents = contents.replace(r"{python_version}", python_version)
+        with open(file_name, "w") as f:
+            f.write(contents)
 
 
-with open('Pipfile', 'w') as f:
-    f.write(pipfile)
+def remove_docker():
+    file_names = ["Dockerfile", ".dockerignore"]
+    for file_name in file_names:
+        if os.path.exists(file_name):
+            os.remove(file_name)
+
+
+SUCCESS = "\x1b[1;32m"
+INFO = "\x1b[1;33m"
+TERMINATOR = "\x1b[0m"
+
+
+def main():
+    set_python_version()
+
+    docker = "{{ cookiecutter.docker }}".lower() == "y"
+
+    if not docker:
+        remove_docker()
+
+    print(SUCCESS + "Project successfully initialized" + TERMINATOR)
+
+
+if __name__ == "__main__":
+    main()

hooks/pre_gen_project.py

@@ -1,9 +1,9 @@
 import re
 import sys
 
-MODULE_REGEX = r'^[a-zA-Z][_a-zA-Z0-9]+$'
-module_name = '{{ cookiecutter.repo_name }}'
+MODULE_REGEX = r"^[a-zA-Z][_a-zA-Z0-9]+$"
+module_name = "{{ cookiecutter.repo_name }}"
 
 if not re.match(MODULE_REGEX, module_name):
-    print('ERROR: %s is not a valid Python module name!' % module_name)
+    print("ERROR: %s is not a valid Python module name!" % module_name)
     sys.exit(1)

{{cookiecutter.repo_name}}/.coveragerc

@@ -1,5 +1,6 @@
 [run]
 source = {{cookiecutter.repo_name}}
+omit = {{cookiecutter.repo_name}}/__main__.py
 
 [report]
 exclude_lines =

{{cookiecutter.repo_name}}/.dockerignore

@@ -0,0 +1,7 @@
+# Ignore everything
+**
+
+# ... except for dependencies and source
+!Pipfile
+!Pipfile.lock
+!{{cookiecutter.repo_name}}

{{cookiecutter.repo_name}}/.editorconfig

@@ -10,10 +10,6 @@ insert_final_newline = true
 trim_trailing_whitespace = true
 
 [*.md]
-indent_size = 4
-
-[*.md]
-indent_size = 4
 trim_trailing_whitespace = false
 
 [Makefile]

{{cookiecutter.repo_name}}/.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: Test
+
+on: 
+  pull_request: {}
+  push:
+    branches: master
+    tags: "*"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: {python_version}
+
+      - name: Install dependencies with pipenv
+        run: |
+          pip install pipenv
+          pipenv install --deploy --dev
+
+      - run: pipenv run isort --recursive --diff
+      - run: pipenv run black --check .
+      - run: pipenv run flake8
+      - run: pipenv run mypy
+      - run: pipenv run pytest --cov --cov-fail-under=100
+
+  docker-image:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Build docker image
+        run: docker build . -t {{cookiecutter.repo_name}}:test
+
+      - name: Smoke test docker image
+        run: |
+          docker run --rm {{cookiecutter.repo_name}}:test 10

{{cookiecutter.repo_name}}/.pre-commit-config.yaml

@@ -30,7 +30,7 @@ repos:
     language: system
     entry: pipenv run mypy
     types: [python]
-    pass_filenames: false
+    require_serial: true
 
   - id: pytest
     name: pytest

{{cookiecutter.repo_name}}/Dockerfile

@@ -0,0 +1,38 @@
+FROM python:{python_version}-slim AS base
+
+# Setup env
+ENV LANG C.UTF-8
+ENV LC_ALL C.UTF-8
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV PYTHONFAULTHANDLER 1
+
+
+FROM base AS python-deps
+
+# Install pipenv and compilation dependencies
+RUN pip install pipenv
+RUN apt-get update && apt-get install -y --no-install-recommends gcc
+
+# Install python dependencies in /.venv
+COPY Pipfile .
+COPY Pipfile.lock .
+RUN PIPENV_VENV_IN_PROJECT=1 pipenv install --deploy
+
+
+FROM base AS runtime
+
+# Copy virtual env from python-deps stage
+COPY --from=python-deps /.venv /.venv
+ENV PATH="/.venv/bin:$PATH"
+
+# Create and switch to a new user
+RUN useradd --create-home appuser
+WORKDIR /home/appuser
+USER appuser
+
+# Install application into container
+COPY . .
+
+# Run the executable
+ENTRYPOINT ["python", "-m", "{{cookiecutter.repo_name}}"]
+CMD ["10"]