SQL-tString 项目启动与配置教程

1. 项目目录结构及介绍

SQL-tString 项目的主要目录结构如下：

sql-tstring/
├── .github/
│   └── workflows/
├── src/
│   └── sql_tstring/
│       └── __init__.py
├── tests/
│   └── __init__.py
├── .gitignore
├── LICENSE
├── README.rst
├── pyproject.toml
├── setup.cfg
└── tox.ini

• .github/workflows/: 存放项目的 GitHub Actions 工作流文件，用于自动化测试、构建等操作。
• src/sql_tstring/: 包含项目的主要源代码，__init__.py 文件使得该目录成为一个 Python 包。
• tests/: 包含项目的测试代码。
• .gitignore: 指定 Git 忽略的文件和目录。
• LICENSE: 项目的许可协议文件，本项目采用 MIT 许可。
• README.rst: 项目的详细说明文件，采用 reStructuredText 格式。
• pyproject.toml: Python 项目配置文件，定义了项目的元数据和依赖。
• setup.cfg: 包含项目打包和分发时的配置信息。
• tox.ini: tox 配置文件，用于自动化测试。

2. 项目的启动文件介绍

项目的启动主要是通过 Python 解释器直接运行 src/sql_tstring 目录下的模块。例如，如果需要运行测试，可以在项目根目录下执行以下命令：

python -m sql_tstring

或者在 src/sql_tstring 目录下直接运行具体的 Python 文件。

3. 项目的配置文件介绍

项目的配置主要通过 pyproject.toml 文件进行。以下是一个简单的配置文件示例：

[project]
name = "sql-tstring"
version = "0.1.0"
description = "SQL-tString allows for t-string based construction of sql queries"
authors = ["pgjones <[e-mail]>"]
dependencies = []

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

在这个配置文件中，定义了项目的基本信息，包括名称、版本、描述、作者和依赖。build-system 部分指定了构建系统所需的基础工具和后端。

此外，setup.cfg 文件可以用于更详细地配置项目的打包和分发选项。例如：

[metadata]
name = sql-tstring
version = 0.1.0
author = pgjones
author-email = [e-mail]
description = SQL-tString allows for t-string based construction of sql queries
long-description = File: README.rst
license = MIT
classifiers =
    Programming Language :: Python :: 3
    License :: OSI Approved :: MIT License
    Operating System :: OS Independent

[options]
packages = find:
python_requires = >=3.7
install_requires =
    setuptools
    wheel

在 setup.cfg 文件中，可以指定项目的元数据、依赖关系以及要打包的 Python 包。