remoteVScode

Setup repository remote VSCode in Docker.
Furthermore, the following VSCode/python extensions can be used:

• pylama (linting)
• mypy (typechecking)
• black (autoformater)
• pre-commit (git pre-commit hocks)

Docker container on local machine

Install docker and docker-compose on the container host machine (local or remote).

https://docs.docker.com/install/overview/ https://docs.docker.com/compose/install/

Have the Dockerfile, docker-compose.yml, environment.yml, environment.dev.yml and .devcontainer.json present in your project's root folder. (local or remote) Change the environment.yml/environment.dev.yml to your needs.

Add the following statement to your settings.json. (This is required to run a linux container in VS Code on windows.)

"docker.attachShellCommand.linuxContainer": "//bin/sh"

Install the "Remote - Containers" extension in VS Code.

2 ways to start developing in a local container:

1. Automatic container start

   Make use of ".devcontainer.json"-file by selecting Remote - Containers: Reopen Folder in Container

2. Manual container start

   Start a dev container using docker-compose up dev (To start the image in detached mode (in the background) add an additional -d at the end.)

   You can now use the docker container by selecting Remote - Containers: Attach to Running Container

Using pre-commit (git pre-commit hooks)

Initializing the pre-commit hooks by executing following statement in a shell with an activated dev-environment:

pre-commit install

Pre-commit hocks can be added/altered in the .pre-commit-config.yaml

Using Pylama

Set the following .vscode settings to use pylama as a code linter.

"python.linting.pylintEnabled": false,
"python.linting.pylamaEnabled": true,
"python.linting.enabled": true,

Pylama config can be adapted in pylama.ini.

Mypy

Set the following .vscode settings to enable type checks with mypy.
Note, that pandas stubs are not available as of today (04.11.2019)

"python.linting.mypyEnabled": true,

Black

Set the following .vscode settings to enable black file auto-formating.

"python.formatting.provider": "black",

Shortcut: Format Document Shift + Alt + F