搭建开发环境¶
要为 BeeWare 做出贡献,您需要建立一个开发环境。
先决条件¶
您需要安装以下先决条件。
BeeWare 需要 Python 3.10+ 。您还需要一种管理虚拟环境的方法(如
venv)。
您可以运行以下命令来验证所安装的 Python 版本:
$ python3 --version
如果安装了多个版本的 Python,可能需要用特定的版本号(例如,python3.13)替换python3。
我们建议避免使用最近发布的 Python 版本(即带有".0 "或".1 "微版本号的版本,如 3.14.0)。这是因为在 macOS 上支持 Python 所需的工具经常滞后,而最近发布的稳定 Python 版本通常又不可用。
BeeWare 需要 Python 3.10+ 。您还需要一种管理虚拟环境的方法(如
venv)。
您可以运行以下命令来验证所安装的 Python 版本:
$ python3 --version
如果安装了多个版本的 Python,可能需要用特定的版本号(例如,python3.13)替换python3。
我们建议避免使用最近发布的 Python 版本(即带有".0 "或".1 "微版本号的版本,如 3.14.0)。这是因为在 Linux 上支持 Python 所需的工具通常会滞后,而最近发布的 Python 稳定版本通常又不可用。
BeeWare 需要 Python 3.10+ 。您还需要一种管理虚拟环境的方法(如
venv)。
您可以运行以下命令来验证所安装的 Python 版本:
C:\...>py -3 --version
如果安装了不止一个版本的 Python,可能需要用特定的版本号替换 -3(例如,-python3.13)。
我们建议避免使用最近发布的 Python 版本(即带有".0 "或".1 "微版本号的版本,如 3.14.0)。这是因为在 Windows 上支持 Python 所需的工具通常会滞后,而最近发布的稳定 Python 版本通常又不可用。
设置开发环境¶
为 BeeWare 设置开发环境的推荐方法是使用 虚拟环境,然后安装 BeeWare 的开发版本及其依赖项。
克隆 BeeWare 仓库¶
接下来,访问 GitHub 上的 BeeWare 页面,如果还没有的话,将 fork 仓库 添加到自己的账户中。然后,点击 fork 上的"<>代码 "按钮。如果你的电脑上安装了 GitHub 桌面程序,可以选择 "用 GitHub 桌面打开";否则,复制所提供的 HTTPS URL,然后用命令行将仓库克隆到你的电脑上:
分叉 BeeWare 版本库,然后:
$ git clone https://github.com/<your username>/beeware.git
(用您的 GitHub 用户名代替)
分叉 BeeWare 版本库,然后:
$ git clone https://github.com/<your username>/beeware.git
(用您的 GitHub 用户名代替)
分叉 BeeWare 版本库,然后:
C:\...>git clone https://github.com/<your username>/beeware.git
(用您的 GitHub 用户名代替)
创建虚拟环境¶
要建立虚拟环境并升级 pip,请运行
$ cd beeware
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
$ cd beeware
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
C:\...>cd beeware
C:\...>py -3 -m venv .venv
C:\...>.venv\Scripts\activate
(.venv) $ python -m pip install -U pip
现在,您的提示符前面应该有(.venv)前缀。
安装 {{ 正式名称 }}¶
有了源代码,就可以在开发环境中 编辑安装 BeeWare 了。运行以下命令
(.venv) $ python -m pip install -U -e . --group dev
(.venv) $ python -m pip install -U -e . --group dev
(.venv) C:\...>python -m pip install -U -e . --group dev
启用预提交¶
BeeWare 使用一个名为 pre-commit 的工具来识别简单的问题并规范代码格式。它通过安装一个 git 钩子,在完成任何 git 提交之前自动运行一系列代码精简器。要启用预提交,请运行
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) C:\...>pre-commit install
pre-commit installed at .git/hooks/pre-commit
现在,您可以开始对 {{ 正式名称 }} 进行黑客攻击了!