AVR-VMC-Sandbox-Module

The Sandbox module is where student autonomy code lives. This repo is merely a template. For students to use, they should fork the repo, and then clone their version on the VMC:

ssh [email protected]
cd AVR-VMC/modules
git clone https://github.com/yourusername/AVR-VMC-Sandbox-Module sandbox

It also recommended to delete the .github folder from your fork.

Development

It's assumed you have a version of Python installed from python.org that is the same or newer as defined in the Dockerfile.

First, install Poetry and VS Code Task Runner:

python -m pip install pipx --upgrade
pipx ensurepath
pipx install poetry
pipx install vscode-task-runner
# (Optionally) Add pre-commit plugin
poetry self add poetry-pre-commit-plugin

Now, you can clone the repo and install dependencies:

git clone https://github.com/bellflight/AVR-VMC-Sandbox-Module
cd AVR-VMC-Sandbox-Module
vtr install

Run

poetry shell

to activate the virtual environment.