mirror of
https://github.com/Infinidat/infi.clickhouse_orm.git
synced 2025-08-02 11:10:11 +03:00
update readme
This commit is contained in:
parent
4c6e1417dd
commit
ef2e6e166e
10
README.md
10
README.md
|
@ -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
|
||||
============
|
||||
|
||||
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.
|
||||
|
||||
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,
|
||||
connect to the database and create a table for the model:
|
||||
|
||||
|
|
|
@ -3,7 +3,7 @@ requires = ["setuptools"]
|
|||
build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "clickhouse-orm"
|
||||
name = "ch-orm"
|
||||
description = "A Python library for working with the ClickHouse database"
|
||||
readme = "README.md"
|
||||
keywords = ["ClickHouse", "ORM", 'DB', 'DATABASE', 'OLAP']
|
||||
|
@ -20,7 +20,7 @@ dependencies = [
|
|||
"iso8601 >= 0.1.12",
|
||||
"setuptools"
|
||||
]
|
||||
version = "0.0.2"
|
||||
version = "0.0.3"
|
||||
|
||||
[tool.setuptools.packages.find]
|
||||
where = ["src"]
|
||||
|
|
Loading…
Reference in New Issue
Block a user