From 8ae3ed8a1b1e5cb4831c36334483b0306569be4c Mon Sep 17 00:00:00 2001 From: emisargent <55098699+emisargent@users.noreply.github.com> Date: Fri, 17 Feb 2023 23:53:55 +0000 Subject: [PATCH] Automatically activate venv --- .devcontainer/devcontainer.json | 18 ++++++++++++++---- .devcontainer/welcome-message.txt | 2 +- CONTRIBUTING.rst | 10 ++++++++++ 3 files changed, 25 insertions(+), 5 deletions(-) diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 44711966..e2356f58 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,13 +1,23 @@ // For format details, see https://aka.ms/devcontainer.json { "name": "pallets/flask", + "image": "mcr.microsoft.com/vscode/devcontainers/python:3", - // Features to add to the devcontainer - "features": { - "ghcr.io/devcontainers/features/python:1": {} + // Configure tool-specific properties. + "customizations": { + // Configure properties specific to VS Code. + "vscode": { + // Set *default* container specific settings.json values on container create. + "settings": { + "python.defaultInterpreterPath": "/workspaces/flask/.venv/bin/python", + "python.linting.enabled": true, + "python.linting.pylintEnabled": true + + } + } }, - // Displays a custom welcome message + // Displays a custom welcome message. "onCreateCommand": "sudo cp .devcontainer/welcome-message.txt /usr/local/etc/vscode-dev-containers/first-run-notice.txt", // Runs the initial setup commands after the container is created. diff --git a/.devcontainer/welcome-message.txt b/.devcontainer/welcome-message.txt index 0d2865b8..8f5ee453 100644 --- a/.devcontainer/welcome-message.txt +++ b/.devcontainer/welcome-message.txt @@ -3,5 +3,5 @@ 🛠️ Your environment is setup with all the required dependencies and your fork has been added as a remote. 🚀 To start coding, wait for the "postCreateCommand" to finish setting things up, then: - - run `. .venv/bin/activate` to activate your virtualenv + - make sure the virtualenv is activated by running `. .venv/bin/activate` - run `git checkout -b your-branch-name origin/{main-or-latest-release}` to start working on a new feature or bug fix diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 8976ad61..70a21949 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -83,6 +83,16 @@ a `devcontainer`_ that installs required dependencies for you. finish running. - Checkout a new branch and `start coding`_. +Note that if you reconnect to an existing codespace, you may need to +open a new terminal or run one of the following commands to activate +your python virtualenv: + +- Linux/macOS + + .. code-block:: text + + $ . .venv/bin/activate + .. _GitHub Codespaces: https://docs.github.com/en/codespaces .. _devcontainer: https://docs.github.com/en/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers