PyScaffold 项目使用教程
1. 项目目录结构及介绍
PyScaffold 生成的项目结构如下:
my_project/
|-- .gitignore
|-- .pre-commit-config.yaml
|-- AUTHORS.rst
|-- CHANGELOG.rst
|-- CONTRIBUTING.rst
|-- LICENSE.txt
|-- README.rst
|-- setup.cfg
|-- setup.py
|-- tox.ini
|-- environment.yml
|-- pyproject.toml
|-- src/
| |-- __init__.py
| `-- my_module.py
|-- tests/
| `-- __init__.py
`-- docs/
|-- conf.py
|-- index.rst
my_project/
: 项目根目录.gitignore
: Git 忽略文件列表,用于指定 Git 应该忽略的文件和目录.pre-commit-config.yaml
: pre-commit 配置文件,用于在提交前自动运行一些检查AUTHORS.rst
: 项目贡献者列表CHANGELOG.rst
: 项目更新日志CONTRIBUTING.rst
: 贡献指南,指导如何为项目贡献代码LICENSE.txt
: 项目许可证文件README.rst
: 项目说明文件,用于介绍项目setup.cfg
: 项目配置文件,用于定义项目信息和构建配置setup.py
: 项目设置文件,用于定义项目的安装和打包参数tox.ini
: tox 配置文件,用于自动化测试environment.yml
: Conda 环境文件,用于定义项目的运行环境pyproject.toml
: Python 项目元数据文件src/
: 源代码目录__init__.py
: 初始化文件,用于将目录作为 Python 模块my_module.py
: 项目的主要模块文件
tests/
: 测试代码目录__init__.py
: 初始化文件
docs/
: 文档目录conf.py
: Sphinx 配置文件index.rst
: 文档的起始文件
2. 项目的启动文件介绍
在 PyScaffold 生成的项目中,并没有特定的“启动文件”。通常情况下,你会直接运行 setup.py
来安装项目,或者使用 pip
来安装项目包。如果你想要运行项目中的某个模块,可以直接运行 src/my_module.py
文件。
例如,你可以在命令行中运行以下命令来执行 my_module.py
:
python src/my_module.py
3. 项目的配置文件介绍
项目的主要配置文件是 setup.cfg
,它用于定义项目的基本信息和构建配置。
以下是一些常见的配置选项:
[metadata]
: 定义项目的基本信息,如名称、版本、描述、作者等。[options]
: 定义项目的安装依赖、包的包含路径、数据文件的包含等。[options.packages]
: 指定包含哪些包,默认会包含src
目录下的所有包。[options.entry_points]
: 定义项目入口点,如命令行工具或插件接口。[tool:pytest]
: 配置pytest
测试框架的参数。
另外,pyproject.toml
文件也用于定义项目的元数据和依赖,它是一个新的配置文件格式,旨在替代 setup.py
。
例如,以下是一个简化的 setup.cfg
配置示例:
[metadata]
name = my_project
version = 0.1.0
author = Your Name
author_email = your.email@example.com
description = A brief description of the project
long_description = file: README.rst
license = MIT
classifiers =
Programming Language :: Python :: 3
[options]
packages = find:
install_requires =
numpy
scipy
这个配置定义了项目的基本信息,并且指定了安装依赖为 numpy
和 scipy
。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考