前言
本文将逐步指导你创建一个简单的 python 包,并将其本地安装到机器或云环境中。完成本教程后,你将拥有一个可复用的 python 库,可直接通过 pip
安装或在项目中导入使用。
步骤详解
step 0: 选择构建工具 - 使用 uv
推荐理由:
uv
是类似poetry
的现代打包工具,默认使用hatchling
作为构建后端,支持 pep 517/518 标准。安装方法:
# 通过 homebrew 安装(macos) brew install uv # 或直接通过 pypi pip install uv
step 1: 创建包目录结构
使用 uv
快速初始化项目结构:
uv init --lib my-package
生成后的目录如下:
my_package/ ├── src/ │ └── my_package/ │ ├── __init__.py # 标记为 python 包 │ └── your_code.py # 存放核心代码 │ └── py.typed # 类型标注声明(可选) ├── pyproject.toml # 项目元数据和依赖配置 ├── readme.md # 项目文档 └── .python-version # 指定 python 版本
step 2: 编写包代码
在 src/my_package/your_code.py
中添加功能代码:
# my_package/your_code.py def greet(name: str) -> str: """返回问候语""" return f"hello, {name}!"
step 3: 配置 pyproject.toml
填写项目元数据和依赖项:
[project] name = "my-package" version = "0.1.0" description = "一个简单的本地 python 包示例" readme = "readme.md" authors = [{ name = "sarah glasmacher", email = "sarah@example.com" }] requires-python = ">=3.11" dependencies = [] [build-system] requires = ["hatchling"] build-backend = "hatchling.build"
step 4: 构建分发包
运行以下命令生成 .whl
或 .tar.gz
文件:
uv build
构建完成后,dist/
目录下会生成类似以下的文件:
dist/ ├── my_package-0.1.0-py3-none-any.whl └── my_package-0.1.0.tar.gz
step 5: 本地安装包
方法 1:直接安装构建产物
pip install dist/my_package-0.1.0-py3-none-any.whl
方法 2:以编辑模式安装(实时同步代码)
pip install -e .
step 6: 测试安装
打开 python 终端验证:
from my_package.your_code import greet print(greet("world")) # 输出:hello, world!
关键注意事项
- 模块化设计:将代码按功能拆分为独立模块,便于维护和复用。
- 依赖管理:通过
dependencies
字段声明依赖,或使用uv add <package>
自动更新pyproject.toml
。 - 版本控制:每次发布新版本前更新
version
字段,避免冲突。
扩展应用场景
- 云部署:将打包后的代码上传至 databricks 或 aws lambda,直接调用云端计算资源。
- 协作开发:通过 pypi 发布包(需额外配置),团队成员可直接
pip install
同步代码。
通过本文,你已掌握 python 包的基础构建和本地安装流程。下一阶段可尝试 将包发布到 pypi,实现全球范围内的代码共享!
总结
到此这篇关于如何使用uv构建python包并本地安装的文章就介绍到这了,更多相关uv构建python包并本地安装内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网!
发表评论