首頁 > 後端開發 > Python教學 > 如何建置和部署 Python 程式庫

如何建置和部署 Python 程式庫

Mary-Kate Olsen
發布: 2025-01-22 00:17:14
原創
168 人瀏覽過

在軟體開發中,許多專案涉及使用相同程式碼和邏輯的重複任務。 程式設計師不斷地重寫這些程式碼,導致效率低落。 例如電子郵件驗證或隨機字串產生。

解決方案是將這些程式碼打包到可重複使用的函式庫中。這些庫跨專案安裝和使用,消除了冗餘編碼。 大多數都是開源的並且免費提供。

這是 Python 和 JavaScript 等語言的標準做法。 本教學詳細介紹如何建立 Python 函式庫並將其部署到 PyPI(官方 Python 套件儲存庫)。

專案概覽

本教學將引導您建立和部署與 REST API 互動的開源 Python 函式庫。

Python 庫

該程式庫將包裝 Abstract API 的匯率 REST API。 此 API 提供三個端點:

  • /live:檢索即時匯率。
  • /convert:在貨幣之間轉換金額(例如,5 美元轉換為英鎊)。
  • /historical:擷取指定時間內的歷史匯率。

此程式庫簡化了開發人員的 API 互動。

專案要求

本教學假設您具備 Python 編碼能力,包括物件導向程式設計 (OOP) 和函數使用。 熟悉 Git、GitHub 儲存庫和專案推送也是必要的。

工具和包裝

你需要:

  • Python: 解譯器 (>=3.9)。
  • 請求:用於發出 HTTP 請求。
  • 抽象 API 帳號: 取得 API 金鑰(已提供說明)。
  • Dotenv:用於管理環境變數。
  • 詩: 一個 Python 依賴管理和打包工具。

建立專案

  1. 建立專案目錄:

    <code class="language-bash">mkdir exchangeLibrary</code>
    登入後複製
    登入後複製
    登入後複製
  2. 安裝 virtualenv(如果尚未安裝):

    <code class="language-bash">pip install virtualenv</code>
    登入後複製
    登入後複製
    登入後複製
  3. 導覽至專案目錄:

    <code class="language-bash">cd exchangeLibrary</code>
    登入後複製
    登入後複製
  4. 建立並啟動虛擬環境:

    <code class="language-bash">virtualenv env</code>
    登入後複製
    登入後複製

    啟動(Windows):.envScriptsactivate 啟動(Linux/macOS):source env/bin/activate

  5. 安裝所需的軟體套件:

    <code class="language-bash">pip install requests poetry dotenv</code>
    登入後複製
    登入後複製
  6. 在程式碼編輯器 (PyCharm/VS Code) 中開啟專案。

設定專案資源

  1. 建立 src 目錄: 在內部建立包含 exchange_python__init__.pyexchange.py。 您的結構應類似下圖:

    How to build and deploy a Python library

  2. 建立 test.py 進行單元測試。

  3. 取得您的抽象 API 金鑰: 一個。註冊 Abstract API。 How to build and deploy a Python library b.登入。 c.導覽至匯率 API。 How to build and deploy a Python library d.取得您的主鍵。 How to build and deploy a Python library

  4. 建立 .env 檔案: 新增您的 API 金鑰:

    <code class="language-bash">mkdir exchangeLibrary</code>
    登入後複製
    登入後複製
    登入後複製

    您的結構現在應如下所示:How to build and deploy a Python library

建置 API 包裝器 (exchange.py)

<code class="language-bash">pip install virtualenv</code>
登入後複製
登入後複製
登入後複製

livehistoricalconvert 方法保持原始輸入中的描述。)

測試 API 包裝器 (test.py)

  1. __init__.py:

    <code class="language-bash">cd exchangeLibrary</code>
    登入後複製
    登入後複製
  2. test.py:

    <code class="language-bash">virtualenv env</code>
    登入後複製
    登入後複製
  3. 執行測試:您應該會看到成功的測試結果。 How to build and deploy a Python library

部署專案

  1. 建立.gitignore檔案:新增env.env.

  2. 建立一個README.md檔案。

  3. 建立pyproject.toml:

    <code class="language-bash">pip install requests poetry dotenv</code>
    登入後複製
    登入後複製
  4. 建立 GitHub 儲存庫。

  5. 初始化 Git: git init

  6. 新增遙控器: git remote add origin <your github repo>

  7. 使用您的 GitHub 儲存庫 URL 更新 pyproject.toml

  8. 推送到 GitHub。

部署到 PyPI

  1. 建立 PyPI 帳戶並驗證您的電子郵件。
  2. 設定 2FA。 How to build and deploy a Python library
  3. 產生復原碼。 How to build and deploy a Python library
  4. 使用驗證器應用程式掃描二維碼。 How to build and deploy a Python library
  5. 取得您的 API 令牌。 How to build and deploy a Python library
  6. 建置套件: poetry build
  7. 設定 PyPI 令牌: poetry config pypi-token.pypi <your-api-token>
  8. 發佈: poetry publish

專案維護

更新後,將變更推送到 GitHub、建置 (poetry build) 和重新發布 (poetry publish),根據需要更新 pyproject.toml 中的版本。

安裝與使用

<code class="language-bash">mkdir exchangeLibrary</code>
登入後複製
登入後複製
登入後複製
<code class="language-bash">pip install virtualenv</code>
登入後複製
登入後複製
登入後複製

結論

本教學介紹如何建立 Python 函式庫並將其部署到 PyPI,包括更新和重新發布。 您對開源社群的貢獻有助於改進 Python 開發。

以上是如何建置和部署 Python 程式庫的詳細內容。更多資訊請關注PHP中文網其他相關文章!

來源:php.cn
本網站聲明
本文內容由網友自願投稿,版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容,請聯絡admin@php.cn
作者最新文章
熱門教學
更多>
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板