Add a devcontainer configuration with Docker

README.md

@@ -122,6 +122,7 @@ Answer the prompts with your own desired [options](http://cookiecutter-django.re
     windows [n]: n
     use_pycharm [n]: y
     use_docker [n]: n
+    use_vscode_devcontainer [n]: n
     Select postgresql_version:
     1 - 14
     2 - 13

cookiecutter.json

@@ -17,6 +17,7 @@
   "windows": "n",
   "use_pycharm": "n",
   "use_docker": "n",
+  "use_vscode_devcontainer": "n",
   "postgresql_version": [
     "14",
     "13",

docs/project-generation-options.rst

@@ -52,6 +52,9 @@ use_pycharm:
 use_docker:
     Indicates whether the project should be configured to use Docker_ and `Docker Compose`_.
 
+use_vscode_devcontainer:
+    Indicates whether the project should be configured to use `VS Code Dev Container`_.
+
 postgresql_version:
     Select a PostgreSQL_ version to use. The choices are:
 
@@ -145,6 +148,8 @@ debug:
 .. _Docker: https://github.com/docker/docker
 .. _Docker Compose: https://docs.docker.com/compose/
 
+.. _VS Code Dev Container: https://github.com/microsoft/vscode-dev-containers
+
 .. _PostgreSQL: https://www.postgresql.org/docs/
 
 .. _Gulp: https://github.com/gulpjs/gulp

hooks/post_gen_project.py

@@ -56,17 +56,37 @@ def remove_pycharm_files():
 
 
 def remove_docker_files():
-    shutil.rmtree("compose")
+    if "{{ cookiecutter.use_vscode_devcontainer }}".lower() == "n":
+        shutil.rmtree("compose")
+        file_names = ["local.yml", "production.yml", ".dockerignore"]
+    else:
+        file_names = ["production.yml"]
 
-    file_names = ["local.yml", "production.yml", ".dockerignore"]
     for file_name in file_names:
         os.remove(file_name)
+
     if "{{ cookiecutter.use_pycharm }}".lower() == "y":
         file_names = ["docker_compose_up_django.xml", "docker_compose_up_docs.xml"]
         for file_name in file_names:
             os.remove(os.path.join(".idea", "runConfigurations", file_name))
 
 
+def remove_vscode_devcontainer_files():
+    dir_path = ".devcontainer"
+    if os.path.exists(dir_path):
+        shutil.rmtree(dir_path)
+
+
+def create_vscode_devcontainer_bash_history_file():
+    history_dir_path = ".history"
+    if not os.path.exists(history_dir_path):
+        os.mkdir(history_dir_path)
+
+    history_file_path = ".history/bash_history"
+    with open(history_file_path, "a"):
+        pass
+
+
 def remove_utility_files():
     shutil.rmtree("utility")
 
@@ -449,6 +469,11 @@ def main():
     else:
         remove_docker_files()
 
+    if "{{ cookiecutter.use_vscode_devcontainer }}".lower() == "n":
+        remove_vscode_devcontainer_files()
+    else:
+        create_vscode_devcontainer_bash_history_file()
+
     if (
         "{{ cookiecutter.use_docker }}".lower() == "y"
         and "{{ cookiecutter.cloud_provider}}" != "AWS"
@@ -463,12 +488,14 @@ def main():
     if (
         "{{ cookiecutter.use_docker }}".lower() == "n"
         and "{{ cookiecutter.use_heroku }}".lower() == "n"
+        and "{{ cookiecutter.use_vscode_devcontainer }}".lower() == "n"
     ):
         if "{{ cookiecutter.keep_local_envs_in_vcs }}".lower() == "y":
             print(
                 INFO + ".env(s) are only utilized when Docker Compose and/or "
-                "Heroku support is enabled so keeping them does not "
-                "make sense given your current setup." + TERMINATOR
+                "Heroku and/or VS Code Dev Container support is enabled so "
+                "keeping them does not make sense given your current setup."
+                + TERMINATOR
             )
         remove_envs_and_associated_files()
     else:

{{cookiecutter.project_slug}}/.devcontainer/bashrc.override.sh

@@ -0,0 +1,16 @@
+
+#
+# .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

{{cookiecutter.project_slug}}/.devcontainer/devcontainer.json

@@ -0,0 +1,83 @@
+// For format details, see https://containers.dev/implementors/json_reference/
+{
+    "name": "{{cookiecutter.project_slug}}_dev",
+    "dockerComposeFile": [
+        "../local.yml"
+    ],
+    "init": true,
+    "mounts": [
+        {
+            "source": "./.history/bash_history",
+            "target": "/home/vscode/.bash_history",
+            "type": "bind"
+        },
+        {
+            "source": "/tmp",
+            "target": "/tmp",
+            "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": true,
+    "service": "django",
+    // "remoteEnv": {"PATH": "/home/vscode/.local/bin:${containerEnv:PATH}"},
+    "remoteUser": "vscode",
+    "workspaceFolder": "/app",
+    // Set *default* container specific settings.json values on container create.
+    "customizations": {
+        "vscode": {
+            "settings": {
+                "editor.formatOnSave": true,
+                "isort.args": [
+                    "--profile",
+                    "black"
+                ],
+                "[python]": {
+                    "analysis.autoImportCompletions": true,
+                    "analysis.typeCheckingMode": "basic",
+                    "defaultInterpreterPath": "/usr/local/bin/python",
+                    "editor.codeActionsOnSave": {
+                        "source.organizeImports": true
+                    },
+                    //"editor.defaultFormatter": "ms-python.black-formatter",
+                    // "formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+                    "formatting.blackPath": "/usr/local/bin/black",
+                    "formatting.provider": "black",
+                    // "formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+                    "languageServer": "Pylance",
+                    // "linting.banditPath": "/usr/local/py-utils/bin/bandit",
+                    "linting.enabled": true,
+                    "linting.flake8Enabled": true,
+                    "linting.flake8Path": "/usr/local/bin/flake8",
+                    "linting.mypyEnabled": true,
+                    "linting.mypyPath": "/usr/local/bin/mypy",
+                    "linting.pycodestylePath": "/usr/local/bin/pycodestyle",
+                    // "linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
+                    "linting.pylintEnabled": true,
+                    "linting.pylintPath": "/usr/local/bin/pylint"
+                }
+            },
+            // https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_vs-code-specific-properties
+            // Add the IDs of extensions you want installed when the container is created.
+            "extensions": [
+                "davidanson.vscode-markdownlint",
+                "mrmlnc.vscode-duplicate",
+                "visualstudioexptteam.vscodeintellicode",
+                "visualstudioexptteam.intellicode-api-usage-examples",
+                // python
+                "ms-python.python",
+                "ms-python.vscode-pylance",
+                "ms-python.isort",
+                // django
+                "batisteo.vscode-django"
+            ]
+        }
+    },
+    // 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"
+}

{{cookiecutter.project_slug}}/.prettierignore

@@ -0,0 +1 @@
+*.html

{{cookiecutter.project_slug}}/compose/local/django/Dockerfile

@@ -35,6 +35,18 @@ ENV BUILD_ENV ${BUILD_ENVIRONMENT}
 
 WORKDIR ${APP_HOME}
 
+{% if cookiecutter.use_vscode_devcontainer == "y" %}
+# VS Code devcontainer dependencies and utils
+RUN apt-get update && apt-get install --no-install-recommends -y \
+  sudo git bash-completion nano
+
+# Create vscode user and add it to sudoers
+RUN groupadd --gid 1000 vscode \
+  && useradd --uid 1000 --gid vscode --shell /bin/bash --create-home vscode \
+  && echo vscode ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/vscode \
+  && chmod 0440 /etc/sudoers.d/vscode
+{% endif %}
+
 # Install required system dependencies
 RUN apt-get update && apt-get install --no-install-recommends -y \
   # psycopg2 dependencies
@@ -51,7 +63,7 @@ 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/
+  && rm -rf /wheels/
 
 COPY ./compose/production/django/entrypoint /entrypoint
 RUN sed -i 's/\r$//g' /entrypoint