Poetry Core 项目安装与使用教程

Poetry Core 项目安装与使用教程

1. 项目的目录结构及介绍

poetry-core/
├── poetry/
│   ├── core/
│   │   ├── __init__.py
│   │   ├── ...
│   ├── ...
├── tests/
│   ├── __init__.py
│   ├── ...
├── pyproject.toml
├── README.md
├── LICENSE
├── ...

目录结构说明

• poetry/core/: 这是项目的主要代码目录，包含了所有核心功能的实现。
  • __init__.py: 初始化文件，用于导入模块。
  • ...: 其他相关代码文件。
• tests/: 包含项目的测试代码。
  • __init__.py: 初始化文件，用于导入测试模块。
  • ...: 其他测试相关文件。
• pyproject.toml: 项目的配置文件，定义了项目的构建系统和依赖。
• README.md: 项目的介绍文档，通常包含项目的概述、安装方法和使用说明。
• LICENSE: 项目的许可证文件，定义了项目的开源许可类型。

2. 项目的启动文件介绍

在 poetry-core 项目中，没有明确的“启动文件”，因为该项目是一个库，而不是一个可执行的应用程序。项目的核心功能是通过导入 poetry.core 模块来使用的。

例如，如果你想要使用 poetry-core 作为你的构建后端，你可以在你的 pyproject.toml 文件中添加如下配置：

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是 poetry-core 项目的主要配置文件，它遵循 PEP 517 和 PEP 518 的标准。以下是一个典型的 pyproject.toml 文件示例：

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

[tool.poetry]
name = "your-project-name"
version = "0.1.0"
description = "A brief description of your project"
authors = ["Your Name <your.email@example.com>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.8"

[tool.poetry.dev-dependencies]
pytest = "^5.2"

配置文件说明

• [build-system]: 定义了构建系统的要求和构建后端。
  • requires: 列出了构建项目所需的依赖项，通常包括 poetry-core。
  • build-backend: 指定了构建后端的模块路径，这里是 poetry.core.masonry.api。
• [tool.poetry]: 定义了项目的元数据，如项目名称、版本、描述、作者和许可证。
• [tool.poetry.dependencies]: 列出了项目运行时所需的依赖项。
• [tool.poetry.dev-dependencies]: 列出了开发和测试所需的依赖项。

通过以上配置，你可以使用 poetry-core 作为你的构建后端，并管理你的项目依赖。