Code CleanUp and consolidation with django cookiecutter

.devcontainer/bashrc.override.sh

@@ -0,0 +1,20 @@
+
+#
+# .bashrc.override.sh
+#
+
+# persistent bash history
+HISTFILE=~/.bash_history
+PROMPT_COMMAND="history -a; $PROMPT_COMMAND"
+
+# set some django env vars
+source /entrypoint
+
+# restore default shell options
+set +o errexit
+set +o pipefail
+set +o nounset
+
+# start ssh-agent
+# https://code.visualstudio.com/docs/remote/troubleshooting
+eval "$(ssh-agent -s)"

.devcontainer/devcontainer.json

@@ -0,0 +1,38 @@
+// For format details, see https://containers.dev/implementors/json_reference/
+{
+  "name": "cookie_cutter_dev",
+  "dockerComposeFile": ["../local.yml"],
+  "init": true,
+  "mounts": [
+    {
+      "source": "./.devcontainer/bash_history",
+      "target": "/home/dev-user/.bash_history",
+      "type": "bind"
+    },
+    {
+      "source": "/tmp",
+      "target": "/tmp",
+      "type": "bind"
+    },
+    {
+      "source": "~/.ssh",
+      "target": "/home/dev-user/.ssh",
+      "type": "bind"
+    }
+  ],
+  // Tells devcontainer.json supporting services / tools whether they should run
+  // /bin/sh -c "while sleep 1000; do :; done" when starting the container instead of the container’s default command
+  "overrideCommand": false,
+  "service": "django",
+  // "remoteEnv": {"PATH": "/home/dev-user/.local/bin:${containerEnv:PATH}"},
+  "remoteUser": "dev-user",
+  "workspaceFolder": "/app",
+  // Set *default* container specific settings.json values on container create.
+  "customizations": {},
+  // Uncomment the next line if you want start specific services in your Docker Compose config.
+  // "runServices": [],
+  // Uncomment the next line if you want to keep your containers running after VS Code shuts down.
+  // "shutdownAction": "none",
+  // Uncomment the next line to run commands after the container is created.
+  "postCreateCommand": "cat .devcontainer/bashrc.override.sh >> ~/.bashrc"
+}

.dockerignore

@@ -0,0 +1,12 @@
+.editorconfig
+.gitattributes
+.github
+.gitignore
+.gitlab-ci.yml
+.idea
+.pre-commit-config.yaml
+.readthedocs.yml
+.travis.yml
+venv
+.git
+.envs/

.editorconfig

@@ -0,0 +1,27 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{py,rst,ini}]
+indent_style = space
+indent_size = 4
+
+[*.{html,css,scss,json,yml,xml}]
+indent_style = space
+indent_size = 2
+
+[*.md]
+trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab
+
+[default.conf]
+indent_style = space
+indent_size = 2

.gitignore

@@ -158,14 +158,14 @@ typings/
 !.vscode/extensions.json
 *.code-workspace
 
-# Local History for Visual Studio Code
-.history/
+# Local History for devcontainer
+.devcontainer/bash_history
 
 
 # Provided default Pycharm Run/Debug Configurations should be tracked by git
 # In case of local modifications made by Pycharm, use update-index command
 # for each changed file, like this:
-# git update-index --assume-unchanged .idea/pycon_portugal_2023.iml
+# git update-index --assume-unchanged .idea/djangocon_2024.iml
 ### JetBrains template
 # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and Webstorm
 # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
@@ -327,8 +327,11 @@ djangocon_2024/media/
 
 .pytest_cache/
 .ipython/
+project.css
+project.min.css
+vendors.js
+*.min.js
+*.min.js.map
 .env
 .envs/*
 !.envs/.local/
-pytest_cache/
-.idea/

.pre-commit-config.yaml

@@ -0,0 +1,59 @@
+exclude: '^docs/|/migrations/'
+default_stages: [commit]
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-json
+        exclude: .devcontainer/devcontainer.json
+      - id: check-toml
+      - id: check-xml
+      - id: check-yaml
+      - id: debug-statements
+      - id: check-builtin-literals
+      - id: check-case-conflict
+      - id: check-docstring-first
+      - id: detect-private-key
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: v3.0.3
+    hooks:
+      - id: prettier
+        args: ['--tab-width', '2', '--single-quote']
+        exclude: 'cookie_cutter/templates/'
+
+  - repo: https://github.com/adamchainz/django-upgrade
+    rev: '1.15.0'
+    hooks:
+      - id: django-upgrade
+        args: ['--target-version', '4.2']
+
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v3.15.0
+    hooks:
+      - id: pyupgrade
+        args: [--py311-plus]
+
+  - repo: https://github.com/psf/black
+    rev: 23.9.1
+    hooks:
+      - id: black
+
+  - repo: https://github.com/PyCQA/isort
+    rev: 5.12.0
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/PyCQA/flake8
+    rev: 6.1.0
+    hooks:
+      - id: flake8
+
+# sets up .pre-commit-ci.yaml to ensure pre-commit dependencies stay up to date
+ci:
+  autoupdate_schedule: weekly
+  skip: []
+  submodules: false

README.md

@@ -10,17 +10,19 @@
 ## Running
 
 First, make sure to have all requirements installed using:
+
 ```bash
 > pip install -r requirements/[ local | production ].txt
 ```
 
 And create a PostgreSQL database 'djangocon_2024'
-* On Debian-based 10+: 
+
+- On Debian-based 10+:
+
 ```bash
 sudo su - postgres -c "createdb djangocon_2024"
 ```
 
-
 ## Code of Conduct
 
 As a contributor, you can help us keep the Django community open and inclusive.
@@ -32,6 +34,5 @@ Get started contributing by reading our [Contributing](CONTRIBUTING.md) guidelin
 
 ## Built With
 
-* [Python](https://docs.python.org/3/) - Programming language
-* [Django](https://docs.djangoproject.com/) - Web framework
-
+- [Python](https://docs.python.org/3/) - Programming language
+- [Django](https://docs.djangoproject.com/) - Web framework

compose.yml

@@ -0,0 +1,16 @@
+version: '3'
+
+services:
+  django:
+    build:
+      context: .
+      dockerfile: compose/django/Dockerfile
+    image: djangocon_2024_local_django
+    container_name: djangocon_2024_local_django
+    volumes:
+      - .:/app:z
+    env_file:
+      - ./.envs/.django
+    ports:
+      - '8000:8000'
+    command: /start

compose/django/Dockerfile

@@ -0,0 +1,71 @@
+# define an alias for the specific python version used in this file.
+FROM python:3.11.6-slim-bullseye as python
+
+# Python build stage
+FROM python as python-build-stage
+
+ARG BUILD_ENVIRONMENT=local
+
+# Install apt packages
+RUN apt-get update && apt-get install --no-install-recommends -y \
+  # dependencies for building Python packages
+  build-essential \
+  # psycopg2 dependencies
+  libpq-dev
+
+# Requirements are installed here to ensure they will be cached.
+COPY ./requirements .
+
+# Create Python Dependency and Sub-Dependency Wheels.
+RUN pip wheel --wheel-dir /usr/src/app/wheels  \
+  -r ${BUILD_ENVIRONMENT}.txt
+
+
+# Python 'run' stage
+FROM python as python-run-stage
+
+ARG BUILD_ENVIRONMENT=local
+ARG APP_HOME=/app
+
+ENV PYTHONUNBUFFERED 1
+ENV PYTHONDONTWRITEBYTECODE 1
+ENV BUILD_ENV ${BUILD_ENVIRONMENT}
+
+WORKDIR ${APP_HOME}
+
+
+# devcontainer dependencies and utils
+RUN apt-get update && apt-get install --no-install-recommends -y \
+  sudo git bash-completion nano ssh
+
+# Create devcontainer user and add it to sudoers
+RUN groupadd --gid 1000 dev-user \
+  && useradd --uid 1000 --gid dev-user --shell /bin/bash --create-home dev-user \
+  && echo dev-user ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/dev-user \
+  && chmod 0440 /etc/sudoers.d/dev-user
+
+
+# Install required system dependencies
+RUN apt-get update && apt-get install --no-install-recommends -y \
+  # psycopg2 dependencies
+  libpq-dev \
+  # Translations dependencies
+  gettext \
+  # cleaning up unused files
+  && apt-get purge -y --auto-remove -o APT::AutoRemove::RecommendsImportant=false \
+  && rm -rf /var/lib/apt/lists/*
+
+# All absolute dir copies ignore workdir instruction. All relative dir copies are wrt to the workdir instruction
+# copy python dependency wheels from python-build-stage
+COPY --from=python-build-stage /usr/src/app/wheels  /wheels/
+
+# use wheels to install python dependencies
+RUN pip install --no-cache-dir --no-index --find-links=/wheels/ /wheels/* \
+  && rm -rf /wheels/
+
+COPY ./compose/django/start /start
+RUN sed -i 's/\r$//g' /start
+RUN chmod +x /start
+
+# copy application code to WORKDIR
+COPY . ${APP_HOME}

compose/django/start

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -o errexit
+set -o pipefail
+set -o nounset
+
+
+python manage.py migrate
+exec python manage.py runserver_plus 0.0.0.0:8000