TDDA 项目教程

TDDA 项目教程

tdda Test-Driven Data Analysis Functions 项目地址: https://gitcode.com/gh_mirrors/tdd/tdda

1. 项目目录结构及介绍

TDDA 项目的目录结构如下：

tdda/
├── bin/
├── doc/
├── tdda/
│   ├── constraints/
│   ├── gentest/
│   ├── rexpy/
│   └── referencetest/
├── .gitignore
├── README.md
├── LICENSE.txt
├── MANIFEST.in
├── pyproject.toml
├── requirements.txt
├── rtdrequirements.txt
└── setup.cfg

目录介绍

• bin/: 存放可执行文件或脚本的目录。
• doc/: 存放项目文档的目录。
• tdda/: 项目的主要代码目录，包含多个子模块：
  • constraints/: 用于数据约束发现和验证的模块。
  • gentest/: 用于自动生成测试的模块。
  • rexpy/: 用于自动推断正则表达式的模块。
  • referencetest/: 用于参考测试的模块。
• .gitignore: Git 忽略文件配置。
• README.md: 项目介绍和使用说明。
• LICENSE.txt: 项目许可证文件。
• MANIFEST.in: 用于打包的清单文件。
• pyproject.toml: Python 项目配置文件。
• requirements.txt: 项目依赖文件。
• rtdrequirements.txt: 用于 Read the Docs 的依赖文件。
• setup.cfg: 项目安装配置文件。

2. 项目启动文件介绍

TDDA 项目没有明确的“启动文件”，因为它是一个库项目，主要通过命令行工具或 Python API 来使用。不过，项目中包含一些命令行工具，可以通过以下方式启动：

命令行工具

• tdda: 用于数据分析和测试的命令行工具。
• rexpy: 用于自动推断正则表达式的命令行工具。

启动方式

1. 安装项目：

   pip install tdda
   

2. 使用命令行工具：

   tdda --help
   rexpy --help
   

3. 项目配置文件介绍

setup.cfg

setup.cfg 是项目的安装配置文件，用于定义项目的元数据和安装选项。以下是 setup.cfg 的部分内容示例：

[metadata]
name = tdda
version = 2.2.05
description = Test-Driven Data Analysis (Python TDDA library)
long_description = file: README.md
long_description_content_type = text/markdown
url = https://github.com/tdda/tdda
author = Stochastic Solutions
author_email = info@stochasticsolutions.com
license = MIT
classifiers =
    Development Status :: 5 - Production/Stable
    Intended Audience :: Developers
    License :: OSI Approved :: MIT License
    Programming Language :: Python :: 3
    Programming Language :: Python :: 3.5
    Programming Language :: Python :: 3.6
    Programming Language :: Python :: 3.7
    Programming Language :: Python :: 3.8
    Programming Language :: Python :: 3.9

[options]
packages = find:
install_requires =
    pandas
    numpy
    pytest
    unittest2

[options.extras_require]
dev =
    pytest
    coverage
    tox

pyproject.toml

pyproject.toml 是 Python 项目的配置文件，用于定义项目的构建系统和依赖。以下是 pyproject.toml 的部分内容示例：

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

requirements.txt

requirements.txt 是项目的依赖文件，列出了项目运行所需的所有 Python 包。以下是 requirements.txt 的部分内容示例：

pandas
numpy
pytest
unittest2

rtdrequirements.txt

rtdrequirements.txt 是用于 Read the Docs 的依赖文件，确保文档构建时所需的依赖项。以下是 rtdrequirements.txt 的部分内容示例：

sphinx
sphinx_rtd_theme

通过以上配置文件，可以确保项目在安装、构建和文档生成过程中的一致性和正确性。

tdda Test-Driven Data Analysis Functions 项目地址: https://gitcode.com/gh_mirrors/tdd/tdda