RedisTimeSeries Python 客户端教程
1. 项目的目录结构及介绍
redistimeseries-py/
├── LICENSE
├── MANIFEST.in
├── README.md
├── pyproject.toml
├── redistimeseries/
│ ├── __init__.py
│ ├── client.py
│ └── ...
├── test_commands.py
└── tox.ini
LICENSE
: 项目的许可证文件。MANIFEST.in
: 用于指定在打包时需要包含的非 Python 文件。README.md
: 项目说明文档。pyproject.toml
: 项目配置文件,用于构建工具。redistimeseries/
: 项目的主要代码目录。__init__.py
: 模块初始化文件。client.py
: 客户端实现文件。...
: 其他辅助文件。
test_commands.py
: 测试命令文件。tox.ini
: 用于配置 tox 测试工具。
2. 项目的启动文件介绍
项目的启动文件主要是 redistimeseries/client.py
,该文件定义了与 RedisTimeSeries 模块交互的客户端类。以下是该文件的主要内容:
from redistimeseries.client import Client
# 示例用法
rts = Client()
rts.create('test', labels={'Time': 'Series'})
rts.add('test', 1, 1, 12)
rts.add('test', 2, 1, 12)
print(rts.get('test'))
3. 项目的配置文件介绍
项目的配置文件主要是 pyproject.toml
,该文件用于配置项目的构建工具和依赖项。以下是该文件的主要内容:
[tool.poetry]
name = "redistimeseries-py"
version = "0.1.0"
description = "RedisTimeSeries python client"
authors = ["RedisTimeSeries <your-email@example.com>"]
license = "BSD-3-Clause"
readme = "README.md"
[tool.poetry.dependencies]
python = "^3.6"
redis = "^3.5.3"
[tool.poetry.dev-dependencies]
pytest = "^6.2.2"
tox = "^3.23.0"
[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"
[tool.poetry]
: 项目的基本信息,包括名称、版本、描述、作者和许可证。[tool.poetry.dependencies]
: 项目的依赖项,包括 Python 版本和 Redis 库。[tool.poetry.dev-dependencies]
: 开发依赖项,包括测试工具 pytest 和 tox。[build-system]
: 构建系统的要求和后端。