Welly 项目教程

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

Welly 项目的目录结构如下：

welly/
├── AUTHORS.md
├── CHANGES.md
├── CITATION.cff
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── conftest.py
├── pyproject.toml
├── requirements.txt
├── run_tests.py
├── setup.cfg
├── setup.py
├── docs/
│   └── ...
├── github/
│   └── workflows/
│       └── ...
├── tests/
│   └── ...
├── tutorial/
│   └── ...
└── welly/
    └── ...

目录结构介绍

• AUTHORS.md: 项目贡献者列表。
• CHANGES.md: 项目变更日志。
• CITATION.cff: 项目引用信息。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 项目贡献指南。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• conftest.py: 测试配置文件。
• pyproject.toml: 项目配置文件。
• requirements.txt: 项目依赖文件。
• run_tests.py: 运行测试脚本。
• setup.cfg: 项目安装配置文件。
• setup.py: 项目安装脚本。
• docs/: 项目文档目录。
• github/workflows/: GitHub Actions 工作流配置目录。
• tests/: 项目测试目录。
• tutorial/: 项目教程目录。
• welly/: 项目核心代码目录。

2. 项目的启动文件介绍

Welly 项目的启动文件主要是 setup.py 和 run_tests.py。

setup.py

setup.py 是 Python 项目的标准安装脚本。它包含了项目的元数据和依赖信息，可以通过以下命令安装项目：

pip install .

run_tests.py

run_tests.py 是用于运行项目测试的脚本。可以通过以下命令运行测试：

python run_tests.py

3. 项目的配置文件介绍

Welly 项目的主要配置文件包括 setup.cfg、pyproject.toml 和 requirements.txt。

setup.cfg

setup.cfg 是项目的安装配置文件，包含了项目的元数据、依赖信息和其他安装选项。

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，用于定义项目的构建系统和依赖管理。

requirements.txt

requirements.txt 是项目的依赖文件，列出了项目运行所需的所有 Python 包。可以通过以下命令安装依赖：

pip install -r requirements.txt

通过以上介绍，您可以更好地理解和使用 Welly 项目。