apache / apache/datasketches-python

Homebrew installations of python throw an error on building

未關閉
#46 2 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
Jupyter Notebook
星號
46
分支
9
PR 合併指標
30 天內沒有已合併 PR

描述

When building with a homebrew installation of python an error is raised. We can avoid this by installing in a virtual environment as suggested by the error message. For example
```
>> which python3
>> /opt/homebrew/bin/python3

>> python3 -m pip install .
>> error: externally-managed-environment

× This environment is externally managed
╰─> To install Python packages system-wide, try brew install
xyz, where xyz is the package you are trying to
install.

If you wish to install a non-brew-packaged Python package,
create a virtual environment using python3 -m venv path/to/venv.
Then use path/to/venv/bin/python and path/to/venv/bin/pip.

If you wish to install a non-brew packaged Python application,
it may be easiest to use pipx install xyz, which will manage a
virtual environment for you. Make sure you have pipx installed.

note: If you believe this is a mistake, please contact your Python installation or OS distribution provider. You can override this, at the risk of breaking your Python installation or OS, by passing --break-system-packages.
hint: See PEP 668 for the detailed specification.
```

It is easy to resolve this by doing (in an appropriate directory, eg. assume the following is in project root).
I propose to add the following notes to the build and installation part of the readme.
```
python3 -m venv venv
source venv/bin/activate
python3 -m pip install .
python3 -m pip install tox
tox
```

貢獻指南

這個儲存庫沒有索引到貢獻指南

研究方向

從 README 的建置與安裝部分開始,如有需要,重現 Homebrew Python 安裝錯誤。加入提議的虛擬環境指令,然後執行 tox,以驗證文件中所述的設定是否可運作。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
python
領域
documentation
Issue 類型
文件
難度
1/5
預估耗時
1 小時以內
活躍度
停滯
描述清晰度
描述清楚
新手友好度
55/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。