Skip to content

DOC: Update docs to remove instructions on using setup.py #62389

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

DOC: Update docs to remove instructions on using setup.py #62389

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3d016ab
Update .gitpod.yml
DevpriyaDave Dec 6, 2023
bd081ac
Merge branch 'pandas-dev:main' into main
DevpriyaDave Sep 12, 2025
0e5e94e
Merge branch 'main' of https://github.com/pandas-dev/pandas
DevpriyaDave Sep 19, 2025
2181658
Update contributing docs to remove setup.py reference
DevpriyaDave Sep 20, 2025
3999581
Undo unnessary changes
DevpriyaDave Sep 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions doc/source/development/contributing_codebase.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -907,8 +907,7 @@ will only run the ``GroupByMethods`` benchmark defined in ``groupby.py``.

You can also run the benchmark suite using the version of ``pandas``
already installed in your current Python environment. This can be
useful if you do not have virtualenv or conda, or are using the
``setup.py develop`` approach discussed above; for the in-place build
useful if you do not have virtualenv or conda; for the in-place build
you need to set ``PYTHONPATH``, e.g.
``PYTHONPATH="$PWD/.." asv [remaining arguments]``.
You can run benchmarks using an existing Python
Expand Down
23 changes: 0 additions & 23 deletions doc/source/development/contributing_environment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,6 @@ for :ref:`building pandas with GitPod <contributing-gitpod>`.
Step 3: build and install pandas
--------------------------------

There are currently two supported ways of building pandas, pip/meson and setuptools(setup.py).
Historically, pandas has only supported using setuptools to build pandas. However, this method
requires a lot of convoluted code in setup.py and also has many issues in compiling pandas in parallel
due to limitations in setuptools.
Comment on lines -214 to 216
Copy link
Member

Choose a reason for hiding this comment

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

I think we can probably remove this entire paragraph: for current readers of this document, it doesn't really matter that in the past we used setuptools, it just matters that right now we use meson

(and also the next two paragraphs could be reworded slightly)

Copy link
Author

Choose a reason for hiding this comment

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

Thank you for reviewing, will update.

Expand Down Expand Up @@ -255,28 +254,6 @@ With pip, it is possible to chain together multiple config settings. For example
and building with debug symbols would look like
``-Cbuilddir="your builddir here" -Csetup-args="-Dbuildtype=debug"``.

**Compiling pandas with setup.py**

.. note::
This method of compiling pandas will be deprecated and removed very soon, as the meson backend matures.

To compile pandas with setuptools, run::

python setup.py develop

.. note::
If pandas is already installed (via meson), you have to uninstall it first::

python -m pip uninstall pandas

This is because python setup.py develop will not uninstall the loader script that ``meson-python``
uses to import the extension from the build folder, which may cause errors such as an
``FileNotFoundError`` to be raised.

.. note::
You will need to repeat this step each time the C extensions change, for example
if you modified any file in ``pandas/_libs`` or if you did a fetch and merge from ``upstream/main``.

**Checking the build**

At this point you should be able to import pandas from your locally built version::
Expand Down
Loading