VSCode setup for containerized dev

Author: Michael Ricks-Aherne

.devcontainer/Dockerfile

@@ -0,0 +1,15 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.231.6/containers/python-3/.devcontainer/base.Dockerfile
+
+# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
+ARG VARIANT="3.10-bullseye"
+FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}
+ENV PYTHONUNBUFFERED 1
+WORKDIR /workspaces/Slay-The-Spire-in-Python
+RUN /usr/local/py-utils/bin/pipx install --system-site-packages --pip-args '--no-cache-dir --force-reinstall' isort && \
+    /usr/local/py-utils/bin/pipx install --system-site-packages --pip-args '--no-cache-dir --force-reinstall' poetry && \
+    pip install --upgrade pip
+RUN chown -R vscode:vscode /home/vscode/.config && \
+    /usr/local/py-utils/bin/poetry completions bash > /etc/bash_completion.d/poetry.bash-completion
+
+
+

.devcontainer/devcontainer.json

@@ -0,0 +1,44 @@
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the
+// README at: https://github.com/devcontainers/templates/tree/main/src/python
+{
+	"name": "Python 3",
+
+	"build": {
+    "dockerfile": "Dockerfile",
+    "context": "..",
+    "args": {
+      // Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6
+      // Append -bullseye or -buster to pin to an OS version.
+      // Use -bullseye variants on local on arm64/Apple Silicon.
+      "VARIANT": "3.10",
+      // Options
+      "POETRY_VERSION": "1.1.13"
+			}
+		},
+
+		// Set *default* container specific settings.json values on container create.
+		"settings": {
+			"python.defaultInterpreterPath": "/usr/local/bin/python",
+			"python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
+			"python.formatting.blackPath": "/usr/local/py-utils/bin/black",
+			"python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
+			"python.analysis.lintingEnabled": true,
+			"python.analysis.linter": "pylint",
+			"python.analysis.linting.pylintArgs": ["--rcfile", "/path/to/your/.pylintrc"]
+		},
+		// Add the IDs of extensions you want installed when the container is created.
+		"extensions": [
+			"ms-python.python",
+			"ms-python.vscode-pylance",
+	    "ms-python.pylint"
+		],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	  "postCreateCommand": "bash ./.devcontainer/post-install.sh"
+
+	// Configure tool-specific properties.
+	// "customizations": {},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

.devcontainer/post-install.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+# Placeholder
+echo "Running post-install.sh"
+poetry install --no-root

.dockerignore

@@ -0,0 +1,6 @@
+.dockerignore
+.env
+.venv
+.pytest_cache
+.pythonlibs
+__pycache__

README.md

@@ -3,3 +3,19 @@ A text based version of Slay the Spire coded in python
 I have no idea how to release the game so just fork the repo and run it in a code editor
 
 DISCLAIMER: I am not a professional, if you wonder why the code sucks, that's why.
+
+
+## VSCode Dev Environment
+
+If using VSCode, there is a devcontainer that can be used to get up and running quickly.  This will install all the dependencies and allow you to run the game.
+
+Quick Start:
+  - Install [VSCode](https://code.visualstudio.com/)
+  - Install [Docker](https://www.docker.com/)
+  - Install [Devcontainer](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) VSCode Extension
+  - Open the project in VSCode
+  - Click the green button in the bottom left corner of VSCode
+  - Select `Dev Container: Reopen in Container`
+  - Wait for the container to build
+  - Open a terminal in VSCode
+  - Run `./scripts/play.sh` to start the game or `./scripts/test.sh` to run the tests

scripts/play.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# Convenience script for running tests locally. Run this from the root of the project.
+poetry run python main.py

scripts/test.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+# Convenience script for running tests locally.
+poetry run pytest -s --full-trace