Release V2

.dockerignore

@@ -1,215 +1,10 @@
+**/__pycache__
+**/*.py[cod]
+**/*$py.class
 
-# Created by https://www.toptal.com/developers/gitignore/api/python,windows,macos,linux
-# Edit at https://www.toptal.com/developers/gitignore?templates=python,windows,macos,linux
+**/.DS_Store
 
-### Linux ###
-*~
-
-# temporary files which can be created if a process still has a handle open of a deleted file
-.fuse_hidden*
-
-# KDE directory preferences
-.directory
-
-# Linux trash folder which might appear on any partition or disk
-.Trash-*
-
-# .nfs files are created when an open file is removed but is still being accessed
-.nfs*
-
-### macOS ###
-# General
-.DS_Store
-.AppleDouble
-.LSOverride
-
-# Icon must end with two \r
-Icon
-
-
-# Thumbnails
-._*
-
-# Files that might appear in the root of a volume
-.DocumentRevisions-V100
-.fseventsd
-.Spotlight-V100
-.TemporaryItems
-.Trashes
-.VolumeIcon.icns
-.com.apple.timemachine.donotpresent
-
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk
-
-### Python ###
-# Byte-compiled / optimized / DLL files
-__pycache__/
-*.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-cover/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-.pybuilder/
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-#   For a library or package, you might want to ignore these files since the code is
-#   intended to run in multiple environments; otherwise, check them in:
-# .python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-
-# pytype static type analyzer
-.pytype/
-
-# Cython debug symbols
-cython_debug/
-
-### Windows ###
-# Windows thumbnail cache files
-Thumbs.db
-Thumbs.db:encryptable
-ehthumbs.db
-ehthumbs_vista.db
-
-# Dump file
-*.stackdump
-
-# Folder config file
-[Dd]esktop.ini
-
-# Recycle Bin used on file shares
-$RECYCLE.BIN/
-
-# Windows Installer files
-*.cab
-*.msi
-*.msix
-*.msm
-*.msp
-
-# Windows shortcuts
-*.lnk
-
-# End of https://www.toptal.com/developers/gitignore/api/python,windows,macos,linux
+app/htmlcov
+app/.coverage
+app/.pytest_cache
+app/.mypy_cache

.docs/Dockerfile

@@ -0,0 +1,64 @@
+# ===== STAGE =====
+FROM python:3.10-slim-buster AS base
+
+ARG USER=turing
+ENV USER $USER
+
+ARG HOME_DIR=/home/${USER}
+ENV HOME_DIR $HOME_DIR
+
+ARG PROJ_DIR=${HOME_DIR}/.docs
+ENV PROJ_DIR $PROJ_DIR
+
+ENV PIP_NO_CACHE_DIR 1
+
+# creates a linux user and group for "USER" (see above) and installs poetry (dependency manager for python)
+# unless one of the lines below are changed, this is only built once
+RUN groupadd "${USER}" \
+    && useradd -rm -d "${HOME_DIR}" -s /bin/bash -g "${USER}" "${USER}" \
+    && mkdir -p "${HOME_DIR}" \
+    && chown "${USER}:${USER}" "${HOME_DIR}" \
+    && pip install "poetry==1.1.*" \
+    && poetry config virtualenvs.create false
+    # poetry must not create a virtualenv inside the container; the line above ensures this
+
+
+# ===== STAGE =====
+FROM base AS requirements
+WORKDIR ${HOME_DIR}
+COPY .docs/pyproject.toml .
+COPY .docs/poetry.lock .
+RUN poetry export > requirements.txt
+
+
+# ===== STAGE =====
+FROM base AS sys-deps
+RUN apt-get update \
+    && apt-get install --no-install-recommends --yes "git=1:2.20.*" \
+    && apt-get clean \
+    && rm -rf /var/lib/apt/lists/*
+
+
+# ===== STAGE =====
+FROM sys-deps AS build
+WORKDIR ${HOME_DIR}
+COPY --from=requirements ["${HOME_DIR}/requirements.txt", "."]
+RUN pip install -r requirements.txt && rm requirements.txt
+
+
+# ===== STAGE =====
+FROM build AS run
+
+WORKDIR ${HOME_DIR}
+COPY .git .git
+COPY app/yapt yapt
+
+WORKDIR ${PROJ_DIR}
+COPY .docs/mkdocs.yml .
+COPY .docs/content content
+
+RUN chown -R "${USER}:${USER}" "${HOME_DIR}"
+
+USER ${USER}
+EXPOSE 8000
+ENTRYPOINT ["mkdocs"]