Docker improvements and fixes

Author: nullhack

README.md

@@ -134,7 +134,7 @@ Don't forget to give the project a star! Thanks again!
 <!-- LICENSE -->
 ## License
 
-Distributed under the MIT License. See [`LICENSE.txt`](https://github.com/nullhack/cookiecutter-python-base-project/blob/main/LICENSE.txt) for more information.
+Distributed under the MIT License. See [`LICENSE`](https://github.com/nullhack/cookiecutter-python-base-project/blob/main/LICENSE) for more information.
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 

{{cookiecutter.project_slug}}/.flake8

@@ -1,11 +1,12 @@
 [flake8]
-ignore = E203, E266, E501, W503, T499, ANN101, ANN102, ANN002, ANN003, S101, SCS108 
+#ignore = E203, E266, E501, W503, T499, ANN101, ANN102, ANN002, ANN003, S101, SCS108 
+ignore = E501
 max-line-length = 79
 enable-extensions=G
 #select = B,C,E,F,W,T4,T0,N8,DC,DAR,SCS
 import-order-style = google
 docstring-convention = google
-#per-file-ignores = tests/*:DC,SCS,ANN,S101 noxfile.py:ANN,DAR101
+per-file-ignores = tests/*:S101, SCS108
 max-complexity = 10
 exclude =
     docs/

{{cookiecutter.project_slug}}/Dockerfile

@@ -1,28 +1,49 @@
-FROM python:3.8.3-slim-buster
+ARG BUILDPLATFORM=linux/amd64
+ARG BUILDTAG=3-alpine
 
-RUN adduser --system user
+FROM --platform=$BUILDPLATFORM python:$BUILDTAG as base_build
 
 WORKDIR /home/user/app
 
-RUN apt-get update && \
-    apt-get install -y git && \
-    chown user /home/user/app && \
-    rm -rf /var/lib/apt/lists/*
-
-USER user
-
-ENV PATH /home/user/.local/bin:${PATH}
-
 COPY {{cookiecutter.package_name}} {{cookiecutter.package_name}}
 COPY tests tests
 COPY pyproject.toml .
 COPY poetry.lock .
+COPY README.md .
 COPY .pre-commit-config.yaml .
 COPY .gitignore .
 COPY .flake8 .
 
-RUN pip install poetry poethepoet --user && \ 
-    poe install
+ENV PATH=$PATH:/home/user/.local/bin
+
+FROM base_build as test
+
+ARG TESTBUILD=True
+ENV TESTBUILD=$TESTBUILD
+
+RUN pip install --no-cache poetry poethepoet
+RUN poetry config --no-cache
+RUN if [ "$TESTBUILD" = 'True' ]; then poe install-dev; fi
+RUN poetry build --format=wheel
+RUN poetry export --only main -f requirements.txt --without-hashes --output requirements.txt
+RUN if [ "$TESTBUILD" = 'True' ]; then poe test; fi
 
 ENTRYPOINT ["poe", "-q"]
-CMD ["run"]
+CMD ["test"]
+
+FROM --platform=$BUILDPLATFORM python:$BUILDTAG as prod
+
+RUN addgroup --system user && adduser --system user --ingroup user
+USER user
+
+WORKDIR /home/user/app
+
+COPY --chown=user:user --from=test /home/user/app/requirements.txt requirements.txt
+COPY --chown=user:user --from=test /home/user/app/dist dist
+
+RUN pip install --no-cache -r requirements.txt dist/*.whl --user
+
+
+ENTRYPOINT ["python", "-m"]
+CMD ["{{cookiecutter.package_name}}.{{cookiecutter.module_name}}"]
+

{{cookiecutter.project_slug}}/poetry.lock

@@ -3,13 +3,20 @@ name = "{{cookiecutter.package_name}}"
 version = "{{cookiecutter.version}}"
 description = "{{cookiecutter.project_short_description}}"
 authors = ["{{cookiecutter.full_name}} <{{cookiecutter.email}}>"]
+maintainers = ["{{cookiecutter.full_name}} <{{cookiecutter.email}}>"]
+license = "{{cookiecutter.license}}"
+repository = "https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}"
+documentation = "https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/tree/main/docs/api/"
+readme = "README.md"
+packages = [
+    { include = "{{cookiecutter.package_name}}" },
+]
 
 [tool.poetry.dependencies]
 python = "^3.8"
 
 [tool.poetry.group.dev.dependencies]
 pre-commit = "^2.18.1"
-mypy = "^0.942"
 isort = "^5.10.1"
 black = {version = "^22.3.0", allow-prereleases = true}
 xdoctest = "^1.0.0"
@@ -19,8 +26,9 @@ pdoc3 = "^0.10.0"
 cookiecutter = "^1.7.3"
 pylint = "^2.13.4"
 poethepoet = "^0.16.4"
-flake8 = "^4.0.1"
 pep8-naming = "^0.12.1"
+mypy = "^0.942"
+flake8 = "^4.0.1"
 flake8-docstrings = "^1.6.0"
 flake8-todos = "^0.1.5"
 flake8-secure-coding-standard = "^1.2.1"
@@ -31,6 +39,8 @@ flake8-bugbear = "^22.3.23"
 flake8-bandit = "^3.0.0"
 flake8-annotations = "^2.8.0"
 flake8-black = "^0.3.2"
+flake8-mypy = "^17.8.0"
+flake8-simplify = "^0.19.3"
 pytest = "7.1.1"
 pytest-html = "^3.1.1"
 pytest-sugar = "^0.9.6"
@@ -76,7 +86,7 @@ exclude = '''
 
 [tool.pytest.ini_options]
 minversion = "6.0"
-addopts = "--verbose --flake8 --reverse --color=yes --cov={{cookiecutter.package_name}} --html=docs/pytest_report.html --self-contained-html --cov-fail-under=100 --cov-report term-missing --cov-report html:docs/cov-report --doctest-modules --cov-config=pyproject.toml"
+addopts = "--verbose --maxfail=1 --flake8 --reverse --color=yes --cov={{cookiecutter.package_name}} --html=docs/pytest_report.html --self-contained-html --cov-fail-under=100 --cov-report term-missing --cov-report html:docs/cov-report --doctest-modules --cov-config=pyproject.toml"
 testpaths = [
     "tests",
     "{{cookiecutter.package_name}}"
@@ -118,4 +128,14 @@ test = "poetry run pytest"
 pre-commit = "poetry run pre-commit run --all-files"
 lint = "poetry run flake8"
 doc = "poetry run pdoc --html . --force --output-dir docs/api"
-build = "docker build -t {{cookiecutter.package_name}}:latest ."
+
+[tool.poe.tasks.docker-build]
+cmd = "docker build --build-arg TESTBUILD=$no_test --build-arg BUILDTAG=$build_tag --build-arg BUILDPLATFORM=$build_platform --target $target_build -t {{cookiecutter.package_name}}:$target_build-$build_tag ."
+help = "Build a docker image to test the project in an isolated environment"
+args = [
+  { name = "no-test", default = true, type = "boolean" }, 
+  { name = "build-tag", default = "3-alpine" },
+  { name = "build-platform", default = "linux/amd64" },
+  { name = "target-build", default = "prod" },
+]
+

{{cookiecutter.project_slug}}/pyproject.toml

@@ -1,6 +1,3 @@
-# -*- coding: utf-8 -*-
-
-
 """This file contains examples of how to write tests using pytest!
 
 Some good practices for writting great Python tests:
@@ -32,7 +29,7 @@ class TestGroup:
     """A class with common parameters, `param1` and `param2`."""
 
     @pytest.fixture()
-    def fixt(self: Self) -> None:
+    def fixt(self: Self) -> int:
         """This fixture will only be available within the scope of TestGroup.
 
         Returns:

{{cookiecutter.project_slug}}/tests/__init__.py

@@ -1,3 +1 @@
-# -*- coding: utf-8 -*-
-
 """{{cookiecutter.project_short_description}}."""

{{cookiecutter.project_slug}}/tests/{{cookiecutter.package_name}}_test.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 """Module Docstring."""
 
 import logging
@@ -11,7 +9,7 @@
 logger.info("This is a {word}", extra={"word": "Log"})
 
 
-class Calculator(object):
+class Calculator:
     """Class for simple calculator operations."""
 
     @staticmethod