在软件开发中,许多项目涉及使用相同代码和逻辑的重复任务。 程序员不断地重写这些代码,导致效率低下。 示例包括电子邮件验证或随机字符串生成。
解决方案是将这些代码打包到可重用的库中。这些库跨项目安装和使用,消除了冗余编码。 大多数都是开源的并且免费提供。
这是 Python 和 JavaScript 等语言的标准做法。 本教程详细介绍了如何构建 Python 库并将其部署到 PyPI(官方 Python 包存储库)。
项目概览
本教程将指导您创建和部署与 REST API 交互的开源 Python 库。
Python 库
该库将包装 Abstract API 的汇率 REST API。 此 API 提供三个端点:
/live
:检索实时汇率。/convert
:在货币之间转换金额(例如,5 美元转换为英镑)。/historical
:检索指定时间段内的历史汇率。该库简化了开发人员的 API 交互。
项目要求
本教程假设您具备 Python 编码能力,包括面向对象编程 (OOP) 和函数使用。 熟悉 Git、GitHub 存储库和项目推送也是必要的。
工具和包
你需要:
创建项目
创建项目目录:
<code class="language-bash">mkdir exchangeLibrary</code>
安装 virtualenv(如果尚未安装):
<code class="language-bash">pip install virtualenv</code>
导航到项目目录:
<code class="language-bash">cd exchangeLibrary</code>
创建并激活虚拟环境:
<code class="language-bash">virtualenv env</code>
激活(Windows):.envScriptsactivate
激活(Linux/macOS):source env/bin/activate
安装所需的软件包:
<code class="language-bash">pip install requests poetry dotenv</code>
在代码编辑器 (PyCharm/VS Code) 中打开项目。
设置项目资源
创建 src
目录: 在内部创建包含 exchange_python
和 __init__.py
的 exchange.py
。 您的结构应类似于下图:
创建 test.py
进行单元测试。
获取您的抽象 API 密钥: 一个。注册 Abstract API。 b.登录。 c.导航至汇率 API。 d.获取您的主键。
创建 .env
文件: 添加您的 API 密钥:
<code class="language-bash">mkdir exchangeLibrary</code>
您的结构现在应如下所示:
构建 API 包装器 (exchange.py
)
<code class="language-bash">pip install virtualenv</code>
(live
、historical
和 convert
方法保持原始输入中的描述。)
测试 API 包装器 (test.py
)
__init__.py
:
<code class="language-bash">cd exchangeLibrary</code>
test.py
:
<code class="language-bash">virtualenv env</code>
运行测试:您应该看到成功的测试结果。
部署项目
创建.gitignore
文件:添加env
、.env
.
创建一个README.md
文件。
创建pyproject.toml
:
<code class="language-bash">pip install requests poetry dotenv</code>
创建 GitHub 存储库。
初始化 Git: git init
添加遥控器: git remote add origin <your github repo>
使用您的 GitHub 存储库 URL 更新 pyproject.toml
。
推送到 GitHub。
部署到 PyPI
poetry build
poetry config pypi-token.pypi <your-api-token>
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中文网其他相关文章!