From e2c2f801102caa9d121086b1f1c78768d0f5574d Mon Sep 17 00:00:00 2001
From: semyonsinchenko <ssinchenko@apache.org>
Date: Thu, 22 Aug 2024 08:55:14 +0200
Subject: [PATCH] Add README and relax a python version

 On branch relax-python
 Changes to be committed:
	new file:   README.md
	modified:   pyproject.toml
---
 README.md      | 35 +++++++++++++++++++++++++++++++++++
 pyproject.toml |  2 +-
 2 files changed, 36 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b5f8190
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Falsa
+
+Falsa is a tool for generating H2O db-like-benchmark.
+This implementation is unofficial! For the official implementation please check [DuckDB fork of orginial H2O project](https://github.com/duckdblabs/db-benchmark/tree/main/_data).
+
+## Quick start
+
+Falsa is built via maturin and pyo3. It works with python 3.9+. For maturin installation please follow [an official documentation](https://www.maturin.rs/installation).
+
+### Maturin build
+
+In virtualenv with python 3.9+:
+
+```sh
+maturin develop --release
+falsa --help
+```
+
+### Pip install
+
+In virtualenv with python 3.9+:
+```sh
+pip install git+https://github.com/mrpowers-io/falsa.git@main
+falsa --help
+```
+
+## Supported output formats
+
+At the moment the following output formats are supported:
+
+- CSV
+- Parquet
+- Delta*
+
+_*There is a problem with Delta at the moment: writing to Delta requires materialization of all `pyarrow` batches first and may be slow and tends to OOM-like errors. We are working on it now and will provide a patched version soon._
diff --git a/pyproject.toml b/pyproject.toml
index bd02213..6053086 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "maturin"
 
 [project]
 name = "falsa"
-requires-python = ">=3.10"
+requires-python = ">=3.9"
 classifiers = [
     "Programming Language :: Rust",
     "Programming Language :: Python :: Implementation :: CPython",