Infinidat/infi.clickhouse_orm
1
1
Fork 0
mirror of https://github.com/Infinidat/infi.clickhouse_orm.git synced 2025-08-02 11:10:11 +03:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
sw 2022-05-29 19:33:35 +08:00
parent 4c6e1417dd
commit ef2e6e166e
2 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -1,9 +1,19 @@
A fork of [infi.clikchouse_orm](https://github.com/Infinidat/infi.clickhouse_orm) aimed at more frequent maintenance and bugfixes.
This repository expects to use more type hints, and will drop support for Python 2.x.
Introduction Introduction
============ ============
This project is simple ORM for working with the [ClickHouse database](https://clickhouse.yandex/). This project is simple ORM for working with the [ClickHouse database](https://clickhouse.yandex/).
It allows you to define model classes whose instances can be written to the database and read from it. It allows you to define model classes whose instances can be written to the database and read from it.
First you have to install like this:
```
pip install ch-orm
```
Let's jump right in with a simple example of monitoring CPU usage. First we need to define the model class, Let's jump right in with a simple example of monitoring CPU usage. First we need to define the model class,
connect to the database and create a table for the model: connect to the database and create a table for the model:

4
pyproject.toml
View File

@ -3,7 +3,7 @@ requires = ["setuptools"]
build-backend = "setuptools.build_meta" build-backend = "setuptools.build_meta"
[project] [project]
name = "clickhouse-orm" name = "ch-orm"
description = "A Python library for working with the ClickHouse database" description = "A Python library for working with the ClickHouse database"
readme = "README.md" readme = "README.md"
keywords = ["ClickHouse", "ORM", 'DB', 'DATABASE', 'OLAP'] keywords = ["ClickHouse", "ORM", 'DB', 'DATABASE', 'OLAP']
@ -20,7 +20,7 @@ dependencies = [
"iso8601 >= 0.1.12", "iso8601 >= 0.1.12",
"setuptools" "setuptools"
] ]
version = "0.0.2" version = "0.0.3"
[tool.setuptools.packages.find] [tool.setuptools.packages.find]
where = ["src"] where = ["src"]