在前面的文章中,量化通分別介紹元富證券的開戶流程,以及使用元富證券前的 API 介紹。接著在本篇文章,我們將要進入正題,教你建置適合元富 API 使用的 Python 環境。
Python 環境建置前準備
在正式進入步驟前,請先確定你的電腦是否滿足下列條件:
- Windows 作業系統:本篇文章會用 Windows 11 Pro 來操作,一般建議使用版本至少要 Windows 10 以上。
- 需安裝 IDE(整合開發環境介紹),本篇將使用使用常見的 Microsoft Visual Studio Code(簡稱 VS Code),如沒有安裝的話,請先至這裡下載。
如果不清楚的 IDE 是什麼的話,可以先參考本篇文章。 - Python 版本:本篇將使用 Python 3.10 的版本進行操作,一般建議使用至少 3.7 以上的版本。
如果沒有安裝 Python 3.10 的版本也沒關係,下面會告訴你如何透過 Pyenv,安裝與本篇文章相同版本的 Python,不過在此之前,你需要先安裝任一版本的 Python。
Python 環境建置流程
步驟一:安裝 Pyenv
為了讓同一台電腦能夠安裝和切換多個 Python 版本,一般我們會需要安裝 Pyenv 來協助在 Windows 作業系統上操作。
只要透過 Pyenv,你就可以為全域或特定專案設定不同的 Python 版本。
至於 Pyenv 的安裝流程,具體如下:
- 使用 pip 進行安裝:
在 PowerShell:
pip install pyenv-win --target $HOME\\.pyenv
在 cmd:
pip install pyenv-win --target %USERPROFILE%\.pyenv
直接在 Windows 的搜尋列搜尋 PowerShell 或是 cmd 即可開啟對應視窗。
- 設定相關的環境變數(使用 PowerShell):
[System.Environment]::SetEnvironmentVariable('PYENV',$env:USERPROFILE + "\.pyenv\pyenv-win\","User") [System.Environment]::SetEnvironmentVariable('PYENV_HOME',$env:USERPROFILE + "\.pyenv\pyenv-win\","User") [System.Environment]::SetEnvironmentVariable('path', $env:USERPROFILE + "\.pyenv\pyenv-win\bin;" + $env:USERPROFILE + "\.pyenv\pyenv-win\shims;" + [System.Environment]::GetEnvironmentVariable('path', "User"),"User")
- 檢查是否安裝成功:
- 重新開啟你的 terminal(PowerShell 或 cmd)。
- 輸入「pyenv –version」指令查看 Pyenv 版本(如下圖)。
步驟二:Pyenv 常用的基本操作
- Pyenv 基本的使用方式如下:
- 查看可安裝 Python 版本,輸入「pyenv install -l」指令。
- 安裝特定 Python 版本,輸入「pyenv install 3.10.5」指令。
- 查看當前 Python 版本,輸入「pyenv version」指令(如下圖)。
- 查看可用 Python 版本,輸入「pyenv versions」指令(如下圖)。
- Pyenv 使用注意:
關於 Pyenv 的操作,下面兩個是根據我自身經驗所分享,你們可以依照自身狀況決定是否要操作。
- [建議]設定此專案使用的 Python 版本,輸入「pyenv local 3.10.5」指令。
- [不強迫使用]設定全域使用的 Python 版本,輸入「pyenv global 3.10.5」指令。請注意,輸入該指令,會讓你其他專案的版本,變成 Python 3.10.5。
元富 API 套件安裝
在執行本步驟之前,請確保已經有元富證券證券帳戶並已申請API權限,若尚未完成請參考此兩篇文章,內有詳細教學。開戶流程、API 申請。
步驟一:安裝套件
- 首先我們我們前往元富數位API專區,在頁面下方可以看到專屬的「下載專區」。
由於我們需要先認證「下單」跟「行情」的 API,才能夠看到報價和執行下單的動作,所以需要先下載上圖中,用黃色標示的「Python」下單API 跟行情 API。
- 將上述的檔案,下載到自己的專案資料夾。
請注意,MasterTradePy 是「下單 API」;SolPYAPI 是「行情 API」。將檔案下載並壓縮後,會跟下圖所顯示的一樣。
- 下載完成後,接著再開啟 VS Code 進入此專案資料,具體步驟如下:
在資料夾內右鍵 → 顯示其他選項 → 使用 Code 開啟
- 接著到「TERMINAL」欄位中,在確認一次版本是否為「3.10.5」。
步驟二:Python 環境管理
再進行下一步認證之前,一般都會建議使用「虛擬環境 (Virtual Environment)」,簡稱「venv」,來管理你的 Python 環境。
至於這樣做的原因,主要是讓你的開發環境更加乾淨,容易管理,有發生什麼錯誤的時候,也不至於影響到你系統上的 Python 環境。
- 在「TERMINAL」輸入下列指令:
python -m venv venv
.\\venv\\Scripts\\activate
指令輸入完成後,如果有出現上圖所示的代碼,就代表成功啟用 venv 虛擬環境。
至於在下一篇文章,我們會開始進入到「下單 API」以及「行情 API」的認證。