Poetry Plugin Export 使用教程
1、项目的目录结构及介绍
poetry-plugin-export/
├── docs/
├── src/
│ └── poetry_plugin_export/
├── tests/
├── .gitignore
├── .pre-commit-config.yaml
├── CHANGELOG.md
├── LICENSE
├── README.md
├── poetry.lock
└── pyproject.toml
- docs/: 存放项目文档的目录。
- src/poetry_plugin_export/: 项目的源代码目录,包含插件的主要功能实现。
- tests/: 存放测试代码的目录。
- .gitignore: Git 忽略文件配置。
- .pre-commit-config.yaml: 预提交钩子配置文件。
- CHANGELOG.md: 项目更新日志。
- LICENSE: 项目许可证。
- README.md: 项目说明文档。
- poetry.lock: Poetry 锁定文件,用于确保依赖版本一致性。
- pyproject.toml: 项目配置文件,包含项目元数据和依赖信息。
2、项目的启动文件介绍
项目的主要功能实现在 src/poetry_plugin_export/
目录下。虽然没有明确的“启动文件”,但主要的入口点是插件的命令行接口,通过 Poetry 的命令行调用。
3、项目的配置文件介绍
pyproject.toml
pyproject.toml
是 Poetry 项目的核心配置文件,包含项目的元数据和依赖信息。以下是该文件的部分内容示例:
[tool.poetry]
name = "poetry-plugin-export"
version = "1.8.0"
description = "Poetry plugin to export the dependencies to various formats"
authors = ["Randy Döring <radoering@gmail.com>"]
license = "MIT"
[tool.poetry.dependencies]
python = "^3.6"
[tool.poetry.dev-dependencies]
pytest = "^5.2"
[tool.poetry.plugins."poetry.application.plugin"]
export = "poetry_plugin_export.export:ExportCommand"
- [tool.poetry]: 项目的基本信息,如名称、版本、描述、作者和许可证。
- [tool.poetry.dependencies]: 项目运行所需的依赖。
- [tool.poetry.dev-dependencies]: 开发环境所需的依赖。
- [tool.poetry.plugins."poetry.application.plugin"]: 插件的入口点配置。
通过以上配置,Poetry 可以识别并加载 poetry-plugin-export
插件,提供导出依赖的功能。