PyCantonese 项目教程

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

PyCantonese 项目的目录结构如下：

pycantonese/
├── circleci/
├── docs/
├── src/
│   └── pycantonese/
├── tests/
├── flake8/
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.txt
├── README.rst
└── pyproject.toml

目录结构介绍

• circleci/: 包含 CircleCI 配置文件，用于持续集成和部署。
• docs/: 包含项目的文档文件，通常是 Markdown 或 reStructuredText 格式。
• src/pycantonese/: 项目的源代码目录，包含主要的 Python 模块和功能实现。
• tests/: 包含项目的测试代码，用于确保代码的正确性和稳定性。
• flake8/: 包含 Flake8 配置文件，用于代码风格检查。
• CHANGELOG.md: 记录项目的版本变更历史。
• CODE_OF_CONDUCT.md: 项目的代码行为准则。
• CONTRIBUTING.md: 项目的贡献指南。
• LICENSE.txt: 项目的开源许可证文件。
• README.rst: 项目的介绍和使用说明。
• pyproject.toml: 项目的配置文件，包含项目依赖、构建工具等信息。

2. 项目的启动文件介绍

PyCantonese 项目的启动文件通常是 src/pycantonese/__init__.py。这个文件是 Python 包的入口点，负责初始化包并加载必要的模块和功能。

启动文件介绍

• __init__.py: 这个文件是 Python 包的标准入口文件，通常包含包的初始化代码和导入其他模块的指令。

3. 项目的配置文件介绍

PyCantonese 项目的主要配置文件是 pyproject.toml。这个文件遵循 PEP 518 标准，用于定义项目的构建系统和依赖项。

配置文件介绍

• pyproject.toml: 这个文件定义了项目的构建系统、依赖项、开发依赖项等信息。它通常包含以下部分：
  • [build-system]: 定义构建系统的要求。
  • [project]: 定义项目的基本信息，如名称、版本、作者等。
  • [tool.poetry]: 如果使用 Poetry 作为依赖管理工具，这部分定义了依赖项和开发依赖项。

示例 pyproject.toml 内容

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

[project]
name = "pycantonese"
version = "3.4.0"
description = "Cantonese Linguistics and NLP in Python"
authors = ["Jackson L. Lee <[e-mail]>"]
license = "MIT"

[tool.poetry]
dependencies = {python = "^3.7"}
dev-dependencies = {pytest = "^6.2.5", flake8 = "^4.0.1"}

通过以上配置文件，可以管理项目的依赖项和构建过程，确保项目的稳定性和可维护性。