[Python][Docs] Use editable pip install invocation in the development docs for PyArrow
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 62/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- python
- Domain
- documentation
Research direction
Start in the PyArrow development documentation and review the current python setup.py build_ext -i instruction alongside pyproject.toml and setup.py. Update the documented workflow to use pip install -e ., then verify that the documented editable-install process supports building PyArrow without directly invoking the deprecated setup.py command.
Written by the indexing model from the issue text.
Description
Currently our docs only use python setup.py build_ext -i for building inplace.
But this is not doing an actual installation, so we should update our docs to do an editable install with pip install -e . (or at least a first time).
With the latest pyproject.toml changes, skipping this installation will now also result in a failure when trying to build pyarrow directly with setup.py (e.g. https://github.com/apache/arrow/issues/41992#issuecomment-2151338952).
Moreover, direct invocation of setup.py is deprecated (although there is no clear alternative in the case of setup.py build_ext, except from re-installing with pip install)
- Dominant language
- C++
- Stars
- 17.1k
- Forks
- 4.3k
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 93
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from apache/arrow
-
Component: Continuous Integration Component: MATLAB Type: enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Component: C++ Component: Parquet Type: enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Component: C++ Component: Parquet
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Component: C++ Type: bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Component: Archery Component: Continuous Integration Component: Developer Tools Type: enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
games-on-whales/wolf#509 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
bug-unconfirmed
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
NVIDIA/cuda-samples#453 ·