infi.clickhouse_orm 项目教程

infi.clickhouse_orm 项目教程

infi.clickhouse_orm A Python library for working with the ClickHouse database (https://clickhouse.yandex/) 项目地址: https://gitcode.com/gh_mirrors/in/infi.clickhouse_orm

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

infi.clickhouse_orm/
├── docs/
│   ├── class_reference.md
│   └── ...
├── examples/
│   ├── example1.py
│   └── ...
├── scripts/
│   ├── script1.py
│   └── ...
├── src/
│   └── infi/
│       ├── clickhouse_orm/
│       │   ├── __init__.py
│       │   └── ...
│       └── ...
├── tests/
│   ├── test1.py
│   └── ...
├── .gitignore
├── CHANGELOG.md
├── LICENSE
├── README.md
├── buildout.cfg
├── setup.in
└── tox.ini

目录结构介绍

• docs/: 包含项目的文档文件，如类参考文档 class_reference.md。
• examples/: 包含项目的示例代码，如 example1.py。
• scripts/: 包含项目的脚本文件，如 script1.py。
• src/infi/clickhouse_orm/: 包含项目的主要源代码，如 __init__.py。
• tests/: 包含项目的测试代码，如 test1.py。
• .gitignore: Git 忽略文件配置。
• CHANGELOG.md: 项目变更日志。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• buildout.cfg: Buildout 配置文件。
• setup.in: 项目安装配置文件。
• tox.ini: Tox 配置文件，用于自动化测试。

2. 项目的启动文件介绍

项目的主要启动文件位于 src/infi/clickhouse_orm/ 目录下。其中，__init__.py 文件是项目的入口文件，负责初始化模块和导入必要的类和函数。

__init__.py 文件介绍

# src/infi/clickhouse_orm/__init__.py

from .database import Database
from .models import Model
from .fields import DateTimeField, UInt16Field, Float32Field
from .engines import Memory

# 其他必要的导入

该文件导入了项目中常用的类和函数，如 Database、Model、DateTimeField 等，方便用户在项目中直接使用。

3. 项目的配置文件介绍

buildout.cfg

buildout.cfg 是一个 Buildout 配置文件，用于自动化项目的构建和依赖管理。

# buildout.cfg

[buildout]
parts =
    myproject

[myproject]
recipe = zc.recipe.egg
eggs = infi.clickhouse_orm

setup.in

setup.in 是一个项目安装配置文件，用于定义项目的依赖和安装选项。

# setup.in

[options]
install_requires =
    infi.clickhouse_orm

tox.ini

tox.ini 是一个 Tox 配置文件，用于自动化测试和环境管理。

# tox.ini

[tox]
envlist = py37, py38

[testenv]
deps =
    infi.clickhouse_orm
commands =
    pytest tests/

这些配置文件共同协作，确保项目能够正确构建、安装和测试。

infi.clickhouse_orm A Python library for working with the ClickHouse database (https://clickhouse.yandex/) 项目地址: https://gitcode.com/gh_mirrors/in/infi.clickhouse_orm