Metadata-Version: 2.4
Name: pysigma-backend-clickhouse
Version: 0.2.0
Summary: Clickhouse backend for sigma
Author-email: souzo <me@souzo.me>
Requires-Python: >=3.13
Requires-Dist: pysigma>=1.0.0
Requires-Dist: pyyaml>=6.0
Description-Content-Type: text/markdown

## Warning

This is not production ready, be careful.

# pySigma Clickhouse Backend

This is the Clickhouse backend for pySigma. It provides the package `sigma.backends.clickhouse` with the `ClickhouseBackend` class.

It supports the following output formats for Sigma rules:
* `default`: plain clickhouse SQL querie
* `clicksiem`: rule format for [clickdetect](https://github.com/clicksiem/clickdetect)

# Thanks

To implement this Clickhouse backend I have leanerd a lot of code, and this is my thanks to most helpful to me.
* Thanks for [SQLite implementation](https://github.com/SigmaHQ/pySigma-backend-sqlite/blob/main/sigma/backends/sqlite/sqlite.py)
* Thanks for the incredible blog post [Creating a Sigma Backend for Fun (and no profit)](https://micahbabinski.medium.com/creating-a-sigma-backend-for-fun-and-no-profit-ed16d20da142)

# Maintainer

Created an maintaned by `souzo`

- [https://github.com/souzomain](https://github.com/souzomain)
- [https://medium.com/@souzo](https://medium.com/@souzo)

# Dev

Setup your dev environment

```sh
uv sync
source .venv/bin/activate
```
