TiDB Vector Python 项目教程

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

TiDB Vector Python 项目的目录结构如下：

tidb-vector-python/
├── examples/
├── tests/
├── tidb_vector/
├── .gitignore
├── .pre-commit-config.yaml
├── LICENSE
├── Makefile
├── README.md
├── poetry.lock
├── pyproject.toml
└── tox.ini

目录介绍

• examples/: 包含使用 TiDB Vector Python SDK 的示例代码。
• tests/: 包含项目的测试代码。
• tidb_vector/: 包含 TiDB Vector Python SDK 的核心代码。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• .pre-commit-config.yaml: 配置预提交钩子。
• LICENSE: 项目的许可证文件，采用 Apache-2.0 许可证。
• Makefile: 包含项目的构建和自动化任务。
• README.md: 项目的介绍文档。
• poetry.lock: 锁定项目依赖的具体版本。
• pyproject.toml: 项目的配置文件，包含项目元数据和依赖。
• tox.ini: 配置 Tox，用于自动化测试。

2. 项目的启动文件介绍

TiDB Vector Python 项目的启动文件位于 tidb_vector/ 目录下。主要的启动文件是 __init__.py，它初始化并导出 SDK 的主要功能。

启动文件介绍

• __init__.py: 初始化 TiDB Vector Python SDK，导出主要功能和类。

3. 项目的配置文件介绍

TiDB Vector Python 项目的配置文件主要包括 pyproject.toml 和 tox.ini。

配置文件介绍

• pyproject.toml: 包含项目的元数据和依赖配置。示例如下：

[tool.poetry]
name = "tidb-vector-python"
version = "0.1.0"
description = "TiDB Vector SDK for Python"
authors = ["Your Name <[e-mail]>"]
license = "Apache-2.0"

[tool.poetry.dependencies]
python = "^3.8"
sqlalchemy = "^1.4"
pymysql = "^1.0"

[tool.poetry.dev-dependencies]
pytest = "^6.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

• tox.ini: 配置 Tox，用于自动化测试。示例如下：

[tox]
envlist = py38, py39

[testenv]
deps =
    pytest
commands =
    pytest tests/

以上是 TiDB Vector Python 项目的目录结构、启动文件和配置文件的介绍。希望这份文档能帮助你更好地理解和使用该项目。