建立開發環境¶
要為 BeeWare 做出貢獻,您必須建立開發環境。
先決條件¶
您需要安裝下列先決條件。
BeeWare 需要 Python 3.10+ 。您也需要一個管理虛擬環境的方法 (例如
venv)。
您可以執行 Python 來驗證已安裝的 Python 版本:
$ python3 --version
如果您安裝了多個版本的 Python,您可能需要將 python3 改為特定的版本號 (例如,python3.13)
我們建議避免使用最近釋出的 Python 版本 (也就是有「.0」或「.1」微版本號的版本,例如 3.14.0)。這是因為在 macOS 上支援 Python 所需的工具經常會滯後,通常無法在最近釋出的 Python 穩定版本上使用。
BeeWare 需要 Python 3.10+ 。您也需要一個管理虛擬環境的方法 (例如
venv)。
您可以執行 Python 來驗證已安裝的 Python 版本:
$ python3 --version
如果您安裝了多個版本的 Python,您可能需要將 python3 改為特定的版本號 (例如,python3.13)
我們建議避免使用最近釋出的 Python 版本 (也就是有「.0」或「.1」微型版本號的版本,例如 3.14.0)。這是因為在 Linux 上支援 Python 所需的工具經常會滯後,通常無法在最近釋出的 Python 穩定版本上使用。
BeeWare 需要 Python 3.10+ 。您也需要一個管理虛擬環境的方法 (例如
venv)。
您可以執行 Python 來驗證已安裝的 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 的 editable install 安裝到您的開發環境中。執行以下指令:
(.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 commit 定稿之前,自動執行一系列的程式碼處理器。要啟用 pre-commit,請執行
(.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
現在您可以開始入侵 BeeWare 了!