Skip to content

Commit 772c540

Browse files
authored
DOC: Added documentation for building using pyenv (#34490)
1 parent e45b348 commit 772c540

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

doc/source/development/contributing.rst

+27-3
Original file line numberDiff line numberDiff line change
@@ -270,7 +270,7 @@ Creating a Python environment (pip)
270270
If you aren't using conda for your development environment, follow these instructions.
271271
You'll need to have at least Python 3.6.1 installed on your system.
272272

273-
**Unix**/**Mac OS**
273+
**Unix**/**Mac OS with virtualenv**
274274

275275
.. code-block:: bash
276276
@@ -286,7 +286,31 @@ You'll need to have at least Python 3.6.1 installed on your system.
286286
python -m pip install -r requirements-dev.txt
287287
288288
# Build and install pandas
289-
python setup.py build_ext --inplace -j 0
289+
python setup.py build_ext --inplace -j 4
290+
python -m pip install -e . --no-build-isolation --no-use-pep517
291+
292+
**Unix**/**Mac OS with pyenv**
293+
294+
Consult the docs for setting up pyenv `here <https://github.com/pyenv/pyenv>`__.
295+
296+
.. code-block:: bash
297+
298+
# Create a virtual environment
299+
# Use an ENV_DIR of your choice. We'll use ~/Users/<yourname>/.pyenv/versions/pandas-dev
300+
301+
pyenv virtualenv <version> <name-to-give-it>
302+
303+
# For instance:
304+
pyenv virtualenv 3.7.6 pandas-dev
305+
306+
# Activate the virtualenv
307+
pyenv activate pandas-dev
308+
309+
# Now install the build dependencies in the cloned pandas repo
310+
python -m pip install -r requirements-dev.txt
311+
312+
# Build and install pandas
313+
python setup.py build_ext --inplace -j 4
290314
python -m pip install -e . --no-build-isolation --no-use-pep517
291315
292316
**Windows**
@@ -312,7 +336,7 @@ should already exist.
312336
python -m pip install -r requirements-dev.txt
313337
314338
# Build and install pandas
315-
python setup.py build_ext --inplace -j 0
339+
python setup.py build_ext --inplace -j 4
316340
python -m pip install -e . --no-build-isolation --no-use-pep517
317341
318342
Creating a branch

0 commit comments

Comments
 (0)