deon 项目使用教程

deon 项目使用教程

deon A command line tool to easily add an ethics checklist to your data science projects. 项目地址: https://gitcode.com/gh_mirrors/de/deon

1. 项目目录结构及介绍

deon 项目的目录结构如下：

deon/
├── docs/
├── examples/
├── tests/
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.txt
├── MANIFEST.in
├── Makefile
├── README.md
├── VERSION
├── dev-requirements.txt
├── pyproject.toml
├── pytest.ini
├── requirements.txt
├── setup.cfg
└── setup.py

目录结构介绍

• docs/: 存放项目的文档文件。
• examples/: 存放项目的示例代码。
• tests/: 存放项目的测试代码。
• .gitignore: Git 忽略文件配置。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 项目贡献指南。
• LICENSE.txt: 项目的开源许可证。
• MANIFEST.in: 用于指定在打包时需要包含的文件。
• Makefile: 项目的 Makefile，用于自动化构建和测试。
• README.md: 项目的介绍和使用说明。
• VERSION: 项目的版本号。
• dev-requirements.txt: 开发环境所需的依赖包。
• pyproject.toml: 项目的配置文件，用于指定构建系统和其他配置。
• pytest.ini: pytest 的配置文件。
• requirements.txt: 项目运行所需的依赖包。
• setup.cfg: setuptools 的配置文件。
• setup.py: 用于安装项目的脚本。

2. 项目启动文件介绍

deon 项目的启动文件是 setup.py。这个文件用于安装项目及其依赖项。你可以通过以下命令来安装 deon：

pip install deon

安装完成后，你可以使用 deon 命令行工具来生成数据科学项目的伦理检查清单。

3. 项目的配置文件介绍

deon 项目的主要配置文件是 pyproject.toml 和 setup.cfg。

pyproject.toml

pyproject.toml 是一个标准的 Python 项目配置文件，用于指定项目的构建系统和其他配置。以下是一个示例：

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "deon"
version = "0.1.0"
description = "A command line tool to easily add an ethics checklist to your data science projects"
authors = [
    { name="DrivenData", email="info@drivendata.org" }
]
dependencies = [
    "click",
    "pyyaml",
    "jinja2"
]

setup.cfg

setup.cfg 是 setuptools 的配置文件，用于指定项目的元数据和其他配置。以下是一个示例：

[metadata]
name = deon
version = 0.1.0
description = A command line tool to easily add an ethics checklist to your data science projects
author = DrivenData
author_email = info@drivendata.org
license = MIT

[options]
packages = find:
install_requires =
    click
    pyyaml
    jinja2

这些配置文件帮助你管理项目的依赖项、元数据和其他设置，确保项目能够正确安装和运行。

deon A command line tool to easily add an ethics checklist to your data science projects. 项目地址: https://gitcode.com/gh_mirrors/de/deon