Skip to content

Improve Development Accesibility - Devcontainer [part 1 / 2] #41721

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

Closed
wants to merge 2 commits into from

Conversation

cgarciae
Copy link

@cgarciae cgarciae commented May 29, 2021

Whats new

This PR introduces some changes that improve the development experience via VSCode's devcontainers. Specifically:

  • It removes the cloning of the pandas repo inside the container (it assumes that the user already cloned it on the host) and instead leverages the fact the the code is mounted to /workspaces/pandas.
  • Defines the conda env inside the workspace itself such that it can be reused even when the container is deleted. This enables you to use the codebase outside the repo afterwards if you activate the same local conda env.
  • Splits the previous Dockerfile in two: a simplified Dockerfile + a new container_create.sh that only runs the first time the container starts, making it possible to install the dependencies inside the workspace.

@cgarciae
Copy link
Author

In the next PR I want to add support for Gitpod which is a nice way to develop when you don't have access to your PC.

Copy link
Contributor

@jreback jreback left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you:

  • update the build instructions in the docs reflecting the changes
  • can we create some sort of test for this (e.g. have a github action that does this)


# build + install pandas
python setup.py build_ext -j 4
python -m pip install -e .
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a final eol

@jreback jreback added the Build Library building on various platforms label May 31, 2021
@jreback
Copy link
Contributor

jreback commented May 31, 2021

@@ -0,0 +1,12 @@
# Switch back to dialog for any ad-hoc use of apt-get
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

-1 on adding this file. I think ideally we shouldn't even have vscode stuff in the repo, and we should be agnostic of what editor or IDE devs are using in this repo. I understand that it can be convenient to have a settings file for vscode, and we already do, but adding more vscode scripts to the repo seems excesive. If ci/setup_env.sh can't be used, and this code can't be added directly to the vscode config file, maybe it's a good time to create a separate project for vscode stuff for pandas development.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea I agree with Mark here. I think adding stuff specific to an IDE is favoring a workflow that we should probably be agnostic to. Maybe better served as a dedicated pandas-vscode repo that just uses pandas as a submodule?

Copy link
Author

@cgarciae cgarciae Aug 5, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmmm. The .devcontainer.json is already an editor-specific file so that line has already been crossed.

How about we create a /.devcontainer folder and move both the .devcontianer.json and container_create.sh files into it? This way we don't have these files pollute the workspace.

@github-actions
Copy link
Contributor

This pull request is stale because it has been open for thirty days with no activity. Please update or respond to this comment if you're still interested in working on this.

@github-actions github-actions bot added the Stale label Jul 11, 2021
@datapythonista
Copy link
Member

Closing this, since there is no agreement on moving forward, and it didn't have any progress for couple of months.

@cgarciae
Copy link
Author

cgarciae commented Aug 5, 2021

Hey @jreback and @datapythonista!
Sorry for the haitus, I got some time again and will be trying to move this forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Build Library building on various platforms Stale
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants