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
```

贡献指南

这个仓库没有索引到贡献指南

调研方向

Start with the README's build and installation section and reproduce the Homebrew Python installation error if needed. Add the proposed virtual-environment commands, then run tox to verify the documented setup works.

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
停滞
描述清晰度
描述清楚
新手友好度
55/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。