PyTimeTK 项目教程

1. 项目目录结构及介绍

PyTimeTK 项目的目录结构如下：

pytimetk/
├── src/
│   └── pytimetk/
│       ├── __init__.py
│       ├── core/
│       ├── utils/
│       └── ...
├── tests/
│   ├── test_core.py
│   ├── test_utils.py
│   └── ...
├── docs/
│   ├── index.md
│   ├── installation.md
│   └── ...
├── README.md
├── LICENSE
├── pyproject.toml
├── poetry.lock
└── ...

目录结构介绍

• src/pytimetk/: 项目的主要代码文件夹，包含了所有核心功能的实现。
  • __init__.py: 初始化文件，用于导入模块。
  • core/: 核心功能模块，包含了时间序列分析的主要功能。
  • utils/: 工具模块，包含了一些辅助函数和工具类。
• tests/: 测试文件夹，包含了项目的单元测试和集成测试。
  • test_core.py: 核心功能模块的测试文件。
  • test_utils.py: 工具模块的测试文件。
• docs/: 文档文件夹，包含了项目的文档和教程。
  • index.md: 文档首页。
  • installation.md: 安装指南。
• README.md: 项目介绍和使用说明。
• LICENSE: 项目许可证文件。
• pyproject.toml: 项目配置文件，用于 Poetry 管理依赖。
• poetry.lock: 依赖锁定文件，确保依赖版本一致性。

2. 项目的启动文件介绍

PyTimeTK 项目没有传统的“启动文件”，因为它是一个库项目，主要通过导入模块来使用。核心功能模块位于 src/pytimetk/core/ 目录下，用户可以通过导入这些模块来使用时间序列分析的功能。

例如，用户可以通过以下方式导入并使用 summarize_by_time 函数：

import pytimetk as tk
import pandas as pd

df = tk.datasets.load_dataset('bike_sales_sample')
df['order_date'] = pd.to_datetime(df['order_date'])

summary_df = df.groupby("category_2").summarize_by_time(
    date_column='order_date',
    value_column='total_price',
    freq="MS",
    agg_func=['mean', 'sum'],
    engine="polars"
)

3. 项目的配置文件介绍

pyproject.toml

pyproject.toml 是 PyTimeTK 项目的主要配置文件，用于 Poetry 管理项目的依赖和构建。以下是该文件的部分内容示例：

[tool.poetry]
name = "pytimetk"
version = "1.0.0"
description = "Time series easier, faster, more fun"
authors = ["Business Science <[e-mail]>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.9"
pandas = "^1.3.0"
polars = "^0.13.0"

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

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

配置文件介绍

• [tool.poetry]: 项目的基本信息，包括项目名称、版本、描述、作者和许可证。
• [tool.poetry.dependencies]: 项目的依赖包及其版本要求。
• [tool.poetry.dev-dependencies]: 开发依赖包，用于测试和开发环境。
• [build-system]: 构建系统的要求和后端。

通过 pyproject.toml 文件，用户可以使用 Poetry 来管理项目的依赖和构建过程，确保项目在不同环境中的一致性。

总结

PyTimeTK 是一个专注于简化时间序列分析的 Python 库，通过其简洁的 API 和高效的计算能力，帮助用户更轻松地进行时间序列数据的处理和分析。项目的目录结构清晰，配置文件简单明了，适合开发者快速上手并集成到自己的项目中。