diff --git a/README.md b/README.md index 247d928..30f3227 100644 --- a/README.md +++ b/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: diff --git a/pyproject.toml b/pyproject.toml index 0b00f14..4736282 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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"]