-
-
Notifications
You must be signed in to change notification settings - Fork 18.6k
ENH: Create DockerFile and devcontainer.json files to work with Docker and VS Code in Containers #30638
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
ENH: Create DockerFile and devcontainer.json files to work with Docker and VS Code in Containers #30638
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
9ba699f
first try
yehoshuadimarsky db62191
progress, messed with conda envs, moved to root folder
yehoshuadimarsky eb3c32f
changed to build-essential, docs
yehoshuadimarsky 5cc8ab2
whitespace trimming
yehoshuadimarsky e454780
whitespace
yehoshuadimarsky b282552
Correctly hard-code pandas-dev for the remote git branch
yehoshuadimarsky 36d3882
removed pylint, added other linting/testing settings for VS Code
yehoshuadimarsky 0a63154
lowercase pandas
yehoshuadimarsky aa7d0dc
Merge remote-tracking branch 'upstream/master' into vscode-env
yehoshuadimarsky 851ea92
Added git pull upstream master
yehoshuadimarsky 76a6b7c
Merge branch 'master' of https://github.com/pandas-dev/pandas into vs…
yehoshuadimarsky 19f4893
specified path for testing in VS code
yehoshuadimarsky File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
// For format details, see https://aka.ms/vscode-remote/devcontainer.json or the definition README at | ||
// https://github.com/microsoft/vscode-dev-containers/tree/master/containers/python-3-miniconda | ||
{ | ||
"name": "pandas", | ||
"context": ".", | ||
"dockerFile": "Dockerfile", | ||
|
||
// Use 'settings' to set *default* container specific settings.json values on container create. | ||
// You can edit these settings after create using File > Preferences > Settings > Remote. | ||
"settings": { | ||
"terminal.integrated.shell.linux": "/bin/bash", | ||
"python.condaPath": "/opt/conda/bin/conda", | ||
"python.pythonPath": "/opt/conda/bin/python", | ||
"python.formatting.provider": "black", | ||
"python.linting.enabled": true, | ||
"python.linting.flake8Enabled": true, | ||
"python.linting.pylintEnabled": false, | ||
"python.linting.mypyEnabled": true, | ||
"python.testing.pytestEnabled": true, | ||
"python.testing.cwd": "pandas/tests" | ||
}, | ||
|
||
// Add the IDs of extensions you want installed when the container is created in the array below. | ||
"extensions": [ | ||
"ms-python.python", | ||
"ms-vscode.cpptools" | ||
] | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
FROM continuumio/miniconda3 | ||
|
||
# if you forked pandas, you can pass in your own GitHub username to use your fork | ||
# i.e. gh_username=myname | ||
ARG gh_username=pandas-dev | ||
ARG pandas_home="/home/pandas" | ||
|
||
# Avoid warnings by switching to noninteractive | ||
ENV DEBIAN_FRONTEND=noninteractive | ||
|
||
# Configure apt and install packages | ||
RUN apt-get update \ | ||
&& apt-get -y install --no-install-recommends apt-utils dialog 2>&1 \ | ||
# | ||
# Verify git, process tools, lsb-release (common in install instructions for CLIs) installed | ||
&& apt-get -y install git iproute2 procps iproute2 lsb-release \ | ||
# | ||
# Install C compilers (gcc not enough, so just went with build-essential which admittedly might be overkill), | ||
# needed to build pandas C extensions | ||
&& apt-get -y install build-essential \ | ||
# | ||
# cleanup | ||
&& apt-get autoremove -y \ | ||
&& apt-get clean -y \ | ||
&& rm -rf /var/lib/apt/lists/* | ||
|
||
# Switch back to dialog for any ad-hoc use of apt-get | ||
ENV DEBIAN_FRONTEND=dialog | ||
|
||
# Clone pandas repo | ||
RUN mkdir "$pandas_home" \ | ||
&& git clone "https://github.com/$gh_username/pandas.git" "$pandas_home" \ | ||
&& cd "$pandas_home" \ | ||
&& git remote add upstream "https://github.com/pandas-dev/pandas.git" \ | ||
&& git pull upstream master | ||
|
||
# Because it is surprisingly difficult to activate a conda environment inside a DockerFile | ||
# (from personal experience and per https://github.com/ContinuumIO/docker-images/issues/89), | ||
# we just update the base/root one from the 'environment.yml' file instead of creating a new one. | ||
# | ||
# Set up environment | ||
RUN conda env update -n base -f "$pandas_home/environment.yml" | ||
|
||
# Build C extensions and pandas | ||
RUN cd "$pandas_home" \ | ||
&& python setup.py build_ext --inplace -j 4 \ | ||
&& python -m pip install -e . |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -146,6 +146,17 @@ requires a C compiler and Python environment. If you're making documentation | |
changes, you can skip to :ref:`contributing.documentation` but you won't be able | ||
to build the documentation locally before pushing your changes. | ||
|
||
Using a Docker Container | ||
~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
Instead of manually setting up a development environment, you can use Docker to | ||
automatically create the environment with just several commands. Pandas provides a `DockerFile` | ||
in the root directory to build a Docker image with a full pandas development environment. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Might be worth linking the docker installation guide in this section There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Where's that? I never saw a docker section. |
||
|
||
Even easier, you can use the DockerFile to launch a remote session with Visual Studio Code, | ||
a popular free IDE, using the `.devcontainer.json` file. | ||
See https://code.visualstudio.com/docs/remote/containers for details. | ||
|
||
.. _contributing.dev_c: | ||
|
||
Installing a C compiler | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.