开源项目 Poetry-Publish 使用教程
1. 项目的目录结构及介绍
poetry-publish/
├── README.md
├── poetry.lock
├── pyproject.toml
├── src/
│ └── poetry_publish/
│ ├── __init__.py
│ ├── publish.py
│ └── utils.py
└── tests/
└── test_publish.py
- README.md: 项目说明文档。
- poetry.lock: Poetry 依赖锁定文件。
- pyproject.toml: 项目配置文件,包含项目元数据和依赖信息。
- src/: 源代码目录。
- poetry_publish/: 项目主代码目录。
- init.py: 包初始化文件。
- publish.py: 发布功能实现文件。
- utils.py: 工具函数文件。
- poetry_publish/: 项目主代码目录。
- tests/: 测试代码目录。
- test_publish.py: 发布功能测试文件。
2. 项目的启动文件介绍
项目的启动文件是 src/poetry_publish/publish.py
。该文件包含了项目的主要功能实现,包括包的构建和发布逻辑。
# src/poetry_publish/publish.py
import subprocess
def build_package():
subprocess.run(["poetry", "build"])
def publish_package():
subprocess.run(["poetry", "publish"])
if __name__ == "__main__":
build_package()
publish_package()
3. 项目的配置文件介绍
项目的配置文件是 pyproject.toml
。该文件使用 TOML 格式,包含了项目的元数据和依赖信息。
[tool.poetry]
name = "poetry-publish"
version = "0.1.0"
description = "A simple tool to publish Python packages using Poetry."
authors = ["Your Name <you@example.com>"]
[tool.poetry.dependencies]
python = "^3.8"
[tool.poetry.dev-dependencies]
pytest = "^5.2"
[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"
- [tool.poetry]: 项目的基本信息,如名称、版本、描述和作者。
- [tool.poetry.dependencies]: 项目运行时的依赖。
- [tool.poetry.dev-dependencies]: 开发时的依赖,如测试框架。
- [build-system]: 构建系统的要求和后端。