Skip to content

Configuring Your IDE

Jump to bottom
Brooks Smith edited this page Feb 7, 2023 · 3 revisions

While you are welcome to use any IDE (Integrated Development Environment) which you choose, this wiki is written assuming you're using VS Code (Visual Studio Code).

First, please refer to VS Code's page on getting started with a Python environment for a detailed explanation of the general process! Roughly, you want to make sure that VS Code can find your Python interpreter, and that you've installed the Python extension (so that VS Code knows how to syntax highlight, autocomplete, and understand your Python files).

Once your general Python environment is set up, you're going to want to install a few extensions that are effectively required by this particular package:

  1. Pylint image
  2. Black image
  3. Mypy image

While not required, I would also highly recommend that you install the following extensions, which may just make your life easier:

  1. Code Spell Checker (let's avoid dumb spelling mistakes in our strings, please :-) )
  2. Git Tree Compare (quickly see all the changes you've made in your branch)
  3. Intellicode (helps autocomplete functions as you type)
  4. Jupyter (if you're going to contribute to the Jupyter portions of this repository)
  5. Python Test Explorer (easier way to run tests as you edit)

Clone this wiki locally