/data-science-docker-vscode-template

Primary LanguageDockerfile

DS Docker VS Code Template

Example template that spins up a self-contained data science environment within a container, that includes:

  1. Conda for Python dependencies
  2. VSCode for full featured development
  3. JupyerLab for quick protyping

Blog post goes into more detail - find it here:

https://binal.pub/2019/04/running-vscode-in-docker/

Completely based on Coder's incredible work. Their GitHub repo here: https://github.com/codercom/code-server

Why is This Useful?

  1. You can develop all your code in a fully specified environment, which makes it much easier to reproduce and deploy models and analysis.

  2. You can (after enabling security) move your IDE to the data. Instead of transferring data back and forth you can develop where your data is stored.

  3. Last - and most important for me - in industries like my own (healthcare), you work with highly regulated data that has to be stored securely, where having multiple copies of data on multiple laptops can pose an unacceptably large risk.

    Running containers like this within a secure environment with access to the data helps us to have an ideal development environment, while ensuring the protected data remains in a secure, single location with no unnecessary duplication.

How to Use This All

Clone this down and rename the folder to be your project name. Modify the environment.yml file to include all the Python packages you need.

docker build -t ds-env .
docker run -p 8443:8443 -p 8888:8888 -v ${PWD}:/workdir --rm -it ds-env

This will spin up the container - starting up JupyerLab and VSCode.

VSCode will be running on:

http://localhost:8443

JupyterLab will be running on:

http://localhost:8888 with a token of local-development

VSCode Extensions and Configuration

You can install any extension and modify configuration like you would locally. Any extensions you install and global configuration you update will persist in the ./data folder so you don't have to redo it every time you restart the container. By default VSCode will start up with the ./code folder as the workspace, which you can change by modifying the docker-entrypoint.sh file.

You can pretty much VSCode as you would locally, doing things like starting up terminals, setting Python formatters/linters, and so on.