首页 > 后端开发 > Python教程 > 如何构建和部署 Python 库

如何构建和部署 Python 库

Mary-Kate Olsen
发布: 2025-01-22 00:17:14
原创
127 人浏览过

在软件开发中,许多项目涉及使用相同代码和逻辑的重复任务。 程序员不断地重写这些代码,导致效率低下。 示例包括电子邮件验证或随机字符串生成。

解决方案是将这些代码打包到可重用的库中。这些库跨项目安装和使用,消除了冗余编码。 大多数都是开源的并且免费提供。

这是 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
作者最新文章
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板