From d4d92118bf81e786dc3feefc4024d9b2d5ab3551 Mon Sep 17 00:00:00 2001 From: sw <935405794@qq.com> Date: Sat, 4 Jun 2022 21:29:49 +0800 Subject: [PATCH] update doc --- .git-blame-ignore-revs | 1 + README.md | 9 +- docs/toc.md | 268 ++++++++++++++++++++-------------------- pyproject.toml | 6 +- scripts/generate_ref.py | 1 + 5 files changed, 146 insertions(+), 139 deletions(-) create mode 100644 .git-blame-ignore-revs diff --git a/.git-blame-ignore-revs b/.git-blame-ignore-revs new file mode 100644 index 0000000..e8f2319 --- /dev/null +++ b/.git-blame-ignore-revs @@ -0,0 +1 @@ +d22683f28c7c59053bd009cedfe35e54e6b3aead diff --git a/README.md b/README.md index 6ce3ec4..8ecbd52 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,10 @@ Supports both synchronous and asynchronous ways to interact with the clickhouse | Build | [![Python 3.7 Tests](https://github.com/sswest/ch-orm/workflows/Python%203.7%20Tests/badge.svg)](https://github.com/sswest/ch-orm/actions?query=Python+3.7+Tests)[![Python 3.8 Tests](https://github.com/sswest/ch-orm/workflows/Python%203.8%20Tests/badge.svg)](https://github.com/sswest/ch-orm/actions?query=Python+3.8+Tests)[![Python 3.9 Tests](https://github.com/sswest/ch-orm/workflows/Python%203.9%20Tests/badge.svg)](https://github.com/sswest/ch-orm/actions?query=Python+3.9+Tests)[![Python 3.10 Tests](https://github.com/sswest/ch-orm/workflows/Python%203.10%20Tests/badge.svg)](https://github.com/sswest/ch-orm/actions?query=Python+3.10+Tests) | -| ----------- | ------------------------------------------------------------ | -| **Package** | [![PyPI](https://img.shields.io/pypi/v/ch-orm.svg)](https://pypi.python.org/pypi/ch-orm)[![PyPI version](https://img.shields.io/pypi/pyversions/ch-orm.svg)](https://pypi.python.org/pypi/ch-orm)[![PyPI Wheel](https://img.shields.io/pypi/wheel/ch-orm.svg)](https://pypi.python.org/pypi/ch-orm)[![Coverage Status](https://coveralls.io/repos/github/sswest/ch-orm/badge.svg?branch=master)](https://coveralls.io/github/sswest/ch-orm?branch=master) | -| **Docs** | [![Documentation](https://camo.githubusercontent.com/bbb44987324f9324879ccae8ff5ad5c30b7e8b37ccee7235841a9628772595fe/68747470733a2f2f72656164746865646f63732e6f72672f70726f6a656374732f73616e69632f62616467652f3f76657273696f6e3d6c6174657374)](http://sswest.github.io/ch-orm) | +| ----------- |-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| **Package** | [![PyPI](https://img.shields.io/pypi/v/ch-orm.svg)](https://pypi.python.org/pypi/ch-orm)[![PyPI version](https://img.shields.io/pypi/pyversions/ch-orm.svg)](https://pypi.python.org/pypi/ch-orm)[![PyPI Wheel](https://img.shields.io/pypi/wheel/ch-orm.svg)](https://pypi.python.org/pypi/ch-orm)[![Coverage Status](https://coveralls.io/repos/github/sswest/ch-orm/badge.svg?branch=master)](https://coveralls.io/github/sswest/ch-orm?branch=master)[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) + | +| **Docs** | [![Documentation](https://camo.githubusercontent.com/bbb44987324f9324879ccae8ff5ad5c30b7e8b37ccee7235841a9628772595fe/68747470733a2f2f72656164746865646f63732e6f72672f70726f6a656374732f73616e69632f62616467652f3f76657273696f6e3d6c6174657374)](https://sswest.github.io/ch-orm) | Introduction ============ @@ -19,4 +20,4 @@ It allows you to define model classes whose instances can be written to the data This and other examples can be found in the `examples` folder. -To learn more please visit the [documentation](docs/toc.md). +To learn more please visit the [documentation](https://sswest.github.io/ch-orm/). diff --git a/docs/toc.md b/docs/toc.md index 2c19b5a..039cb4b 100644 --- a/docs/toc.md +++ b/docs/toc.md @@ -1,147 +1,147 @@ # Table of Contents - * [Overview](index.md#overview) - * [Installation](index.md#installation) + * [Overview](/sswest/ch-orm/blob/master/docs/index.md#overviewindex.md#overview) + * [Installation](/sswest/ch-orm/blob/master/docs/index.md#installation) - * [Models and Databases](models_and_databases.md#models-and-databases) - * [Defining Models](models_and_databases.md#defining-models) - * [Default values](models_and_databases.md#default-values) - * [Null values](models_and_databases.md#null-values) - * [Materialized fields](models_and_databases.md#materialized-fields) - * [Alias fields](models_and_databases.md#alias-fields) - * [Table Names](models_and_databases.md#table-names) - * [Model Constraints](models_and_databases.md#model-constraints) - * [Data Skipping Indexes](models_and_databases.md#data-skipping-indexes) - * [Using Models](models_and_databases.md#using-models) - * [Inserting to the Database](models_and_databases.md#inserting-to-the-database) - * [Reading from the Database](models_and_databases.md#reading-from-the-database) - * [Reading without a Model](models_and_databases.md#reading-without-a-model) - * [SQL Placeholders](models_and_databases.md#sql-placeholders) - * [Counting](models_and_databases.md#counting) - * [Pagination](models_and_databases.md#pagination) + * [Models and Databases](/sswest/ch-orm/blob/master/docs/models_and_databases.md#models-and-databases) + * [Defining Models](/sswest/ch-orm/blob/master/docs/models_and_databases.md#defining-models) + * [Default values](/sswest/ch-orm/blob/master/docs/models_and_databases.md#default-values) + * [Null values](/sswest/ch-orm/blob/master/docs/models_and_databases.md#null-values) + * [Materialized fields](/sswest/ch-orm/blob/master/docs/models_and_databases.md#materialized-fields) + * [Alias fields](/sswest/ch-orm/blob/master/docs/models_and_databases.md#alias-fields) + * [Table Names](/sswest/ch-orm/blob/master/docs/models_and_databases.md#table-names) + * [Model Constraints](/sswest/ch-orm/blob/master/docs/models_and_databases.md#model-constraints) + * [Data Skipping Indexes](/sswest/ch-orm/blob/master/docs/models_and_databases.md#data-skipping-indexes) + * [Using Models](/sswest/ch-orm/blob/master/docs/models_and_databases.md#using-models) + * [Inserting to the Database](/sswest/ch-orm/blob/master/docs/models_and_databases.md#inserting-to-the-database) + * [Reading from the Database](/sswest/ch-orm/blob/master/docs/models_and_databases.md#reading-from-the-database) + * [Reading without a Model](/sswest/ch-orm/blob/master/docs/models_and_databases.md#reading-without-a-model) + * [SQL Placeholders](/sswest/ch-orm/blob/master/docs/models_and_databases.md#sql-placeholders) + * [Counting](/sswest/ch-orm/blob/master/docs/models_and_databases.md#counting) + * [Pagination](/sswest/ch-orm/blob/master/docs/models_and_databases.md#pagination) - * [Async Databases](async_databases.md#async-databases) - * [Insert from the AioDatabase](async_databases.md#insert-from-the-aiodatabase) - * [Reading from the AioDatabase](async_databases.md#reading-from-the-aiodatabase) + * [Async Databases](/sswest/ch-orm/blob/master/docs/async_databases.md#async-databases) + * [Insert from the AioDatabase](/sswest/ch-orm/blob/master/docs/async_databases.md#insert-from-the-aiodatabase) + * [Reading from the AioDatabase](/sswest/ch-orm/blob/master/docs/async_databases.md#reading-from-the-aiodatabase) - * [Querysets](querysets.md#querysets) - * [Filtering](querysets.md#filtering) - * [Using IN and NOT IN](querysets.md#using-in-and not-in) - * [Specifying PREWHERE conditions](querysets.md#specifying-prewhere conditions) - * [Old-style filter conditions](querysets.md#old-style-filter-conditions) - * [Counting and Checking Existence](querysets.md#counting-and-checking existence) - * [Ordering](querysets.md#ordering) - * [Omitting Fields](querysets.md#omitting-fields) - * [Distinct](querysets.md#distinct) - * [Final](querysets.md#final) - * [Slicing](querysets.md#slicing) - * [Pagination](querysets.md#pagination) - * [Mutations](querysets.md#mutations) - * [Aggregation](querysets.md#aggregation) - * [Adding totals](querysets.md#adding-totals) + * [Querysets](/sswest/ch-orm/blob/master/docs/querysets.md#querysets) + * [Filtering](/sswest/ch-orm/blob/master/docs/querysets.md#filtering) + * [Using IN and NOT IN](/sswest/ch-orm/blob/master/docs/querysets.md#using-in-and-not-in) + * [Specifying PREWHERE conditions](/sswest/ch-orm/blob/master/docs/querysets.md#specifying-prewhere-conditions) + * [Old-style filter conditions](/sswest/ch-orm/blob/master/docs/querysets.md#old-style-filter-conditions) + * [Counting and Checking Existence](/sswest/ch-orm/blob/master/docs/querysets.md#counting-and-checking-existence) + * [Ordering](/sswest/ch-orm/blob/master/docs/querysets.md#ordering) + * [Omitting Fields](/sswest/ch-orm/blob/master/docs/querysets.md#omitting-fields) + * [Distinct](/sswest/ch-orm/blob/master/docs/querysets.md#distinct) + * [Final](/sswest/ch-orm/blob/master/docs/querysets.md#final) + * [Slicing](/sswest/ch-orm/blob/master/docs/querysets.md#slicing) + * [Pagination](/sswest/ch-orm/blob/master/docs/querysets.md#pagination) + * [Mutations](/sswest/ch-orm/blob/master/docs/querysets.md#mutations) + * [Aggregation](/sswest/ch-orm/blob/master/docs/querysets.md#aggregation) + * [Adding totals](/sswest/ch-orm/blob/master/docs/querysets.md#adding-totals) - * [Field Options](field_options.md#field-options) - * [default](field_options.md#default) - * [db_column](field_options.md#db_column) - * [alias / materialized](field_options.md#alias-/-materialized) - * [codec](field_options.md#codec) - * [readonly](field_options.md#readonly) + * [Field Options](/sswest/ch-orm/blob/master/docs/field_options.md#field-options) + * [default](/sswest/ch-orm/blob/master/docs/field_options.md#default) + * [db_column](/sswest/ch-orm/blob/master/docs/field_options.md#db_column) + * [alias / materialized](/sswest/ch-orm/blob/master/docs/field_options.md#alias-/-materialized) + * [codec](/sswest/ch-orm/blob/master/docs/field_options.md#codec) + * [readonly](/sswest/ch-orm/blob/master/docs/field_options.md#readonly) - * [Field Types](field_types.md#field-types) - * [DateTimeField and Time Zones](field_types.md#datetimefield-and-time-zones) - * [Working with enum fields](field_types.md#working-with-enum-fields) - * [Working with array fields](field_types.md#working-with-array-fields) - * [Working with tuple fields](field_types.md#working-with-tuple-fields) - * [Working with nullable fields](field_types.md#working-with-nullable-fields) - * [Working with LowCardinality fields](field_types.md#working-with-lowcardinality fields) - * [Creating custom field types](field_types.md#creating-custom-field-types) + * [Field Types](/sswest/ch-orm/blob/master/docs/field_types.md#field-types) + * [DateTimeField and Time Zones](/sswest/ch-orm/blob/master/docs/field_types.md#datetimefield-and-time-zones) + * [Working with enum fields](/sswest/ch-orm/blob/master/docs/field_types.md#working-with-enum-fields) + * [Working with array fields](/sswest/ch-orm/blob/master/docs/field_types.md#working-with-array-fields) + * [Working with tuple fields](/sswest/ch-orm/blob/master/docs/field_types.md#working-with-tuple-fields) + * [Working with nullable fields](/sswest/ch-orm/blob/master/docs/field_types.md#working-with-nullable-fields) + * [Working with LowCardinality fields](/sswest/ch-orm/blob/master/docs/field_types.md#working-with-lowcardinality-fields) + * [Creating custom field types](/sswest/ch-orm/blob/master/docs/field_types.md#creating-custom-field-types) - * [Table Engines](table_engines.md#table-engines) - * [Simple Engines](table_engines.md#simple-engines) - * [Engines in the MergeTree Family](table_engines.md#engines-in-the-mergetree family) - * [Custom partitioning](table_engines.md#custom-partitioning) - * [Primary key](table_engines.md#primary-key) - * [Data Replication](table_engines.md#data-replication) - * [Buffer Engine](table_engines.md#buffer-engine) - * [Merge Engine](table_engines.md#merge-engine) + * [Table Engines](/sswest/ch-orm/blob/master/docs/table_engines.md#table-engines) + * [Simple Engines](/sswest/ch-orm/blob/master/docs/table_engines.md#simple-engines) + * [Engines in the MergeTree Family](/sswest/ch-orm/blob/master/docs/table_engines.md#engines-in-the-mergetree-family) + * [Custom partitioning](/sswest/ch-orm/blob/master/docs/table_engines.md#custom-partitioning) + * [Primary key](/sswest/ch-orm/blob/master/docs/table_engines.md#primary-key) + * [Data Replication](/sswest/ch-orm/blob/master/docs/table_engines.md#data-replication) + * [Buffer Engine](/sswest/ch-orm/blob/master/docs/table_engines.md#buffer-engine) + * [Merge Engine](/sswest/ch-orm/blob/master/docs/table_engines.md#merge-engine) - * [Schema Migrations](schema_migrations.md#schema-migrations) - * [Writing Migrations](schema_migrations.md#writing-migrations) - * [CreateTable](schema_migrations.md#createtable) - * [DropTable](schema_migrations.md#droptable) - * [AlterTable](schema_migrations.md#altertable) - * [AlterTableWithBuffer](schema_migrations.md#altertablewithbuffer) - * [AlterConstraints](schema_migrations.md#alterconstraints) - * [RunPython](schema_migrations.md#runpython) - * [RunSQL](schema_migrations.md#runsql) - * [Running Migrations](schema_migrations.md#running-migrations) + * [Schema Migrations](/sswest/ch-orm/blob/master/docs/schema_migrations.md#schema-migrations) + * [Writing Migrations](/sswest/ch-orm/blob/master/docs/schema_migrations.md#writing-migrations) + * [CreateTable](/sswest/ch-orm/blob/master/docs/schema_migrations.md#createtable) + * [DropTable](/sswest/ch-orm/blob/master/docs/schema_migrations.md#droptable) + * [AlterTable](/sswest/ch-orm/blob/master/docs/schema_migrations.md#altertable) + * [AlterTableWithBuffer](/sswest/ch-orm/blob/master/docs/schema_migrations.md#altertablewithbuffer) + * [AlterConstraints](/sswest/ch-orm/blob/master/docs/schema_migrations.md#alterconstraints) + * [RunPython](/sswest/ch-orm/blob/master/docs/schema_migrations.md#runpython) + * [RunSQL](/sswest/ch-orm/blob/master/docs/schema_migrations.md#runsql) + * [Running Migrations](/sswest/ch-orm/blob/master/docs/schema_migrations.md#running-migrations) - * [System Models](system_models.md#system-models) - * [Partitions and Parts](system_models.md#partitions-and-parts) + * [System Models](/sswest/ch-orm/blob/master/docs/system_models.md#system-models) + * [Partitions and Parts](/sswest/ch-orm/blob/master/docs/system_models.md#partitions-and-parts) - * [Contributing](contributing.md#contributing) - * [Building](contributing.md#building) - * [Tests](contributing.md#tests) + * [Contributing](/sswest/ch-orm/blob/master/docs/contributing.md#contributing) + * [Building](/sswest/ch-orm/blob/master/docs/contributing.md#building) + * [Tests](/sswest/ch-orm/blob/master/docs/contributing.md#tests) - * [Class Reference](class_reference.md#class-reference) - * [infi.clickhouse_orm.database](class_reference.md#inficlickhouse_ormdatabase) - * [Database](class_reference.md#database) - * [DatabaseException](class_reference.md#databaseexception) - * [infi.clickhouse_orm.models](class_reference.md#inficlickhouse_ormmodels) - * [Model](class_reference.md#model) - * [BufferModel](class_reference.md#buffermodel) - * [MergeModel](class_reference.md#mergemodel) - * [DistributedModel](class_reference.md#distributedmodel) - * [Constraint](class_reference.md#constraint) - * [Index](class_reference.md#index) - * [infi.clickhouse_orm.fields](class_reference.md#inficlickhouse_ormfields) - * [ArrayField](class_reference.md#arrayfield) - * [BaseEnumField](class_reference.md#baseenumfield) - * [BaseFloatField](class_reference.md#basefloatfield) - * [BaseIntField](class_reference.md#baseintfield) - * [DateField](class_reference.md#datefield) - * [DateTime64Field](class_reference.md#datetime64field) - * [DateTimeField](class_reference.md#datetimefield) - * [Decimal128Field](class_reference.md#decimal128field) - * [Decimal32Field](class_reference.md#decimal32field) - * [Decimal64Field](class_reference.md#decimal64field) - * [DecimalField](class_reference.md#decimalfield) - * [Enum16Field](class_reference.md#enum16field) - * [Enum8Field](class_reference.md#enum8field) - * [Field](class_reference.md#field) - * [FixedStringField](class_reference.md#fixedstringfield) - * [Float32Field](class_reference.md#float32field) - * [Float64Field](class_reference.md#float64field) - * [IPv4Field](class_reference.md#ipv4field) - * [IPv6Field](class_reference.md#ipv6field) - * [Int16Field](class_reference.md#int16field) - * [Int32Field](class_reference.md#int32field) - * [Int64Field](class_reference.md#int64field) - * [Int8Field](class_reference.md#int8field) - * [LowCardinalityField](class_reference.md#lowcardinalityfield) - * [NullableField](class_reference.md#nullablefield) - * [StringField](class_reference.md#stringfield) - * [UInt16Field](class_reference.md#uint16field) - * [UInt32Field](class_reference.md#uint32field) - * [UInt64Field](class_reference.md#uint64field) - * [UInt8Field](class_reference.md#uint8field) - * [UUIDField](class_reference.md#uuidfield) - * [infi.clickhouse_orm.engines](class_reference.md#inficlickhouse_ormengines) - * [Engine](class_reference.md#engine) - * [TinyLog](class_reference.md#tinylog) - * [Log](class_reference.md#log) - * [Memory](class_reference.md#memory) - * [MergeTree](class_reference.md#mergetree) - * [Buffer](class_reference.md#buffer) - * [Merge](class_reference.md#merge) - * [Distributed](class_reference.md#distributed) - * [CollapsingMergeTree](class_reference.md#collapsingmergetree) - * [SummingMergeTree](class_reference.md#summingmergetree) - * [ReplacingMergeTree](class_reference.md#replacingmergetree) - * [infi.clickhouse_orm.query](class_reference.md#inficlickhouse_ormquery) - * [QuerySet](class_reference.md#queryset) - * [AggregateQuerySet](class_reference.md#aggregatequeryset) - * [Q](class_reference.md#q) - * [infi.clickhouse_orm.funcs](class_reference.md#inficlickhouse_ormfuncs) - * [F](class_reference.md#f) + * [Class Reference](/sswest/ch-orm/blob/master/docs/class_reference.md#class-reference) + * [clickhouse_orm.database](/sswest/ch-orm/blob/master/docs/class_reference.md#clickhouse_ormdatabase) + * [Database](/sswest/ch-orm/blob/master/docs/class_reference.md#database) + * [DatabaseException](/sswest/ch-orm/blob/master/docs/class_reference.md#databaseexception) + * [clickhouse_orm.models](/sswest/ch-orm/blob/master/docs/class_reference.md#clickhouse_ormmodels) + * [Model](/sswest/ch-orm/blob/master/docs/class_reference.md#model) + * [BufferModel](/sswest/ch-orm/blob/master/docs/class_reference.md#buffermodel) + * [MergeModel](/sswest/ch-orm/blob/master/docs/class_reference.md#mergemodel) + * [DistributedModel](/sswest/ch-orm/blob/master/docs/class_reference.md#distributedmodel) + * [Constraint](/sswest/ch-orm/blob/master/docs/class_reference.md#constraint) + * [Index](/sswest/ch-orm/blob/master/docs/class_reference.md#index) + * [clickhouse_orm.fields](/sswest/ch-orm/blob/master/docs/class_reference.md#clickhouse_ormfields) + * [ArrayField](/sswest/ch-orm/blob/master/docs/class_reference.md#arrayfield) + * [BaseEnumField](/sswest/ch-orm/blob/master/docs/class_reference.md#baseenumfield) + * [BaseFloatField](/sswest/ch-orm/blob/master/docs/class_reference.md#basefloatfield) + * [BaseIntField](/sswest/ch-orm/blob/master/docs/class_reference.md#baseintfield) + * [DateField](/sswest/ch-orm/blob/master/docs/class_reference.md#datefield) + * [DateTime64Field](/sswest/ch-orm/blob/master/docs/class_reference.md#datetime64field) + * [DateTimeField](/sswest/ch-orm/blob/master/docs/class_reference.md#datetimefield) + * [Decimal128Field](/sswest/ch-orm/blob/master/docs/class_reference.md#decimal128field) + * [Decimal32Field](/sswest/ch-orm/blob/master/docs/class_reference.md#decimal32field) + * [Decimal64Field](/sswest/ch-orm/blob/master/docs/class_reference.md#decimal64field) + * [DecimalField](/sswest/ch-orm/blob/master/docs/class_reference.md#decimalfield) + * [Enum16Field](/sswest/ch-orm/blob/master/docs/class_reference.md#enum16field) + * [Enum8Field](/sswest/ch-orm/blob/master/docs/class_reference.md#enum8field) + * [Field](/sswest/ch-orm/blob/master/docs/class_reference.md#field) + * [FixedStringField](/sswest/ch-orm/blob/master/docs/class_reference.md#fixedstringfield) + * [Float32Field](/sswest/ch-orm/blob/master/docs/class_reference.md#float32field) + * [Float64Field](/sswest/ch-orm/blob/master/docs/class_reference.md#float64field) + * [IPv4Field](/sswest/ch-orm/blob/master/docs/class_reference.md#ipv4field) + * [IPv6Field](/sswest/ch-orm/blob/master/docs/class_reference.md#ipv6field) + * [Int16Field](/sswest/ch-orm/blob/master/docs/class_reference.md#int16field) + * [Int32Field](/sswest/ch-orm/blob/master/docs/class_reference.md#int32field) + * [Int64Field](/sswest/ch-orm/blob/master/docs/class_reference.md#int64field) + * [Int8Field](/sswest/ch-orm/blob/master/docs/class_reference.md#int8field) + * [LowCardinalityField](/sswest/ch-orm/blob/master/docs/class_reference.md#lowcardinalityfield) + * [NullableField](/sswest/ch-orm/blob/master/docs/class_reference.md#nullablefield) + * [StringField](/sswest/ch-orm/blob/master/docs/class_reference.md#stringfield) + * [UInt16Field](/sswest/ch-orm/blob/master/docs/class_reference.md#uint16field) + * [UInt32Field](/sswest/ch-orm/blob/master/docs/class_reference.md#uint32field) + * [UInt64Field](/sswest/ch-orm/blob/master/docs/class_reference.md#uint64field) + * [UInt8Field](/sswest/ch-orm/blob/master/docs/class_reference.md#uint8field) + * [UUIDField](/sswest/ch-orm/blob/master/docs/class_reference.md#uuidfield) + * [clickhouse_orm.engines](/sswest/ch-orm/blob/master/docs/class_reference.md#clickhouse_ormengines) + * [Engine](/sswest/ch-orm/blob/master/docs/class_reference.md#engine) + * [TinyLog](/sswest/ch-orm/blob/master/docs/class_reference.md#tinylog) + * [Log](/sswest/ch-orm/blob/master/docs/class_reference.md#log) + * [Memory](/sswest/ch-orm/blob/master/docs/class_reference.md#memory) + * [MergeTree](/sswest/ch-orm/blob/master/docs/class_reference.md#mergetree) + * [Buffer](/sswest/ch-orm/blob/master/docs/class_reference.md#buffer) + * [Merge](/sswest/ch-orm/blob/master/docs/class_reference.md#merge) + * [Distributed](/sswest/ch-orm/blob/master/docs/class_reference.md#distributed) + * [CollapsingMergeTree](/sswest/ch-orm/blob/master/docs/class_reference.md#collapsingmergetree) + * [SummingMergeTree](/sswest/ch-orm/blob/master/docs/class_reference.md#summingmergetree) + * [ReplacingMergeTree](/sswest/ch-orm/blob/master/docs/class_reference.md#replacingmergetree) + * [clickhouse_orm.query](/sswest/ch-orm/blob/master/docs/class_reference.md#clickhouse_ormquery) + * [QuerySet](/sswest/ch-orm/blob/master/docs/class_reference.md#queryset) + * [AggregateQuerySet](/sswest/ch-orm/blob/master/docs/class_reference.md#aggregatequeryset) + * [Q](/sswest/ch-orm/blob/master/docs/class_reference.md#q) + * [clickhouse_orm.funcs](/sswest/ch-orm/blob/master/docs/class_reference.md#clickhouse_ormfuncs) + * [F](/sswest/ch-orm/blob/master/docs/class_reference.md#f) diff --git a/pyproject.toml b/pyproject.toml index cf6699b..e6f5743 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -8,8 +8,8 @@ description = "A Python library for working with the ClickHouse database" readme = "README.md" keywords = ["ClickHouse", "ORM", 'DB', 'DATABASE', 'OLAP'] license = {text = "BSD License"} +urls = {Homepage = "https://github.com/sswest/ch-orm", Documentation = "https://sswest.github.io/ch-orm/"} classifiers = [ - "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", @@ -28,3 +28,7 @@ version = "0.2.0" [tool.setuptools.packages.find] where = ["src"] + +[tool.black] +line-length = 100 +target-version = ['py39', 'py37', 'py38'] \ No newline at end of file diff --git a/scripts/generate_ref.py b/scripts/generate_ref.py index bc17f8a..37be8d3 100644 --- a/scripts/generate_ref.py +++ b/scripts/generate_ref.py @@ -4,6 +4,7 @@ from collections import namedtuple DefaultArgSpec = namedtuple('DefaultArgSpec', 'has_default default_value') + def _get_default_arg(args, defaults, arg_index): """ Method that determines if an argument has default value or not, and if yes what is the default value for the argument