Skip to content

Commit fc21503

Browse files
gbaychevproost
authored andcommitted
DOC: Add instructions how to activate virtual env under windows with pip (pandas-dev#29113)
1 parent 46d45a8 commit fc21503

File tree

1 file changed

+31
-2
lines changed

1 file changed

+31
-2
lines changed

doc/source/development/contributing.rst

+31-2
Original file line numberDiff line numberDiff line change
@@ -238,22 +238,51 @@ Creating a Python environment (pip)
238238
If you aren't using conda for your development environment, follow these instructions.
239239
You'll need to have at least python3.5 installed on your system.
240240

241-
.. code-block:: none
241+
**Unix**/**Mac OS**
242+
243+
.. code-block:: bash
242244
243245
# Create a virtual environment
244246
# Use an ENV_DIR of your choice. We'll use ~/virtualenvs/pandas-dev
245247
# Any parent directories should already exist
246248
python3 -m venv ~/virtualenvs/pandas-dev
249+
247250
# Activate the virtualenv
248251
. ~/virtualenvs/pandas-dev/bin/activate
249252
250253
# Install the build dependencies
251254
python -m pip install -r requirements-dev.txt
252255
253256
# Build and install pandas
254-
python setup.py build_ext --inplace -j 4
257+
python setup.py build_ext --inplace -j 0
255258
python -m pip install -e . --no-build-isolation
256259
260+
**Windows**
261+
262+
Below is a brief overview on how to set-up a virtual environment with Powershell
263+
under Windows. For details please refer to the
264+
`official virtualenv user guide <https://virtualenv.pypa.io/en/stable/userguide/#activate-script>`__
265+
266+
Use an ENV_DIR of your choice. We'll use ~\virtualenvs\pandas-dev where
267+
'~' is the folder pointed to by either $env:USERPROFILE (Powershell) or
268+
%USERPROFILE% (cmd.exe) environment variable. Any parent directories
269+
should already exist.
270+
271+
.. code-block:: powershell
272+
273+
# Create a virtual environment
274+
python -m venv $env:USERPROFILE\virtualenvs\pandas-dev
275+
276+
# Activate the virtualenv. Use activate.bat for cmd.exe
277+
~\virtualenvs\pandas-dev\Scripts\Activate.ps1
278+
279+
# Install the build dependencies
280+
python -m pip install -r requirements-dev.txt
281+
282+
# Build and install pandas
283+
python setup.py build_ext --inplace -j 0
284+
python -m pip install -e . --no-build-isolation --no-use-pep517
285+
257286
Creating a branch
258287
-----------------
259288

0 commit comments

Comments
 (0)