@@ -153,14 +153,38 @@ to build the documentation locally before pushing your changes.
153
153
Using a Docker container
154
154
~~~~~~~~~~~~~~~~~~~~~~~~
155
155
156
- Instead of manually setting up a development environment, you can use Docker to
157
- automatically create the environment with just several commands. Pandas provides a `DockerFile `
158
- in the root directory to build a Docker image with a full pandas development environment.
156
+ Instead of manually setting up a development environment, you can use `Docker
157
+ <https://docs.docker.com/get-docker/> `_ to automatically create the environment with just several
158
+ commands. Pandas provides a `DockerFile ` in the root directory to build a Docker image
159
+ with a full pandas development environment.
159
160
160
- Even easier, you can use the DockerFile to launch a remote session with Visual Studio Code,
161
+ **Docker Commands **
162
+
163
+ Pass your GitHub username in the `DockerFile ` to use your own fork::
164
+
165
+ # Build the image pandas-yourname-env
166
+ docker build --tag pandas-yourname-env .
167
+ # Run a container and bind your local forked repo, pandas-yourname, to the container
168
+ docker run -it --rm -v path-to-pandas-yourname:/home/pandas-yourname pandas-yourname-env
169
+
170
+ Even easier, you can integrate Docker with the following IDEs:
171
+
172
+ **Visual Studio Code **
173
+
174
+ You can use the DockerFile to launch a remote session with Visual Studio Code,
161
175
a popular free IDE, using the `.devcontainer.json ` file.
162
176
See https://code.visualstudio.com/docs/remote/containers for details.
163
177
178
+ **PyCharm (Professional) **
179
+
180
+ Enable Docker support and use the Services tool window to build and manage images as well as
181
+ run and interact with containers.
182
+ See https://www.jetbrains.com/help/pycharm/docker.html for details.
183
+
184
+ Note that you might need to rebuild the C extensions if/when you merge with upstream/master using::
185
+
186
+ python setup.py build_ext --inplace -j 4
187
+
164
188
.. _contributing.dev_c :
165
189
166
190
Installing a C compiler
@@ -751,7 +775,7 @@ Imports are alphabetically sorted within these sections.
751
775
752
776
As part of :ref: `Continuous Integration <contributing.ci >` checks we run::
753
777
754
- isort --recursive -- check-only pandas
778
+ isort --check-only pandas
755
779
756
780
to check that imports are correctly formatted as per the `setup.cfg `.
757
781
@@ -770,8 +794,6 @@ You should run::
770
794
771
795
to automatically format imports correctly. This will modify your local copy of the files.
772
796
773
- The `--recursive ` flag can be passed to sort all files in a directory.
774
-
775
797
Alternatively, you can run a command similar to what was suggested for ``black `` and ``flake8 `` :ref: `right above <contributing.code-formatting >`::
776
798
777
799
git diff upstream/master --name-only -- "*.py" | xargs -r isort
0 commit comments