Metadata-Version: 2.4
Name: snakemake-logger-plugin-flowo
Version: 0.1.0
Summary: A Snakemake logger plugin that stores workflow execution data in PostgreSQL
Project-URL: Homepage, https://github.com/your-org/snakemake-logger-plugin-flowo
Project-URL: Repository, https://github.com/your-org/snakemake-logger-plugin-flowo
Project-URL: Issues, https://github.com/your-org/snakemake-logger-plugin-flowo/issues
Author-email: Haomiao Zhang <zhanghm@iregene.com>, Jingmin Zhang <zhangjm@iregene.com>
Keywords: logger,plugin,postgresql,snakemake,workflow
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.12
Requires-Dist: psycopg2-binary>=2.9.9
Requires-Dist: pydantic-settings>=2.9.1
Requires-Dist: pydantic>=2.11.5
Requires-Dist: snakemake-interface-logger-plugins>=1.2.3
Requires-Dist: snakemake==9.6.0
Requires-Dist: sqlalchemy>=2.0.41
Description-Content-Type: text/markdown

# Snakemake Logger Plugin - Flowo

A Snakemake logger plugin that stores workflow execution data in PostgreSQL.

## Features

- Stores Snakemake workflow execution data in PostgreSQL database
- Tracks jobs, rules, files, and errors
- Provides comprehensive logging and monitoring capabilities
- Easy integration with existing Snakemake workflows

## Installation

```bash
pip install snakemake-logger-plugin-flowo
```

## Usage

### 1. Configure Database

Set up your PostgreSQL database and configure the connection:

```bash
export POSTGRES_USER=snakemake
export POSTGRES_PASSWORD=snakemake_password
export POSTGRES_DB=snakemake_logs
```

### 2. Use with Snakemake

Run your Snakemake workflow with the logger plugin:

```bash
snakemake --logger flowo
```

## Configuration

The plugin can be configured using environment variables:

- `POSTGRES_USER`: PostgreSQL username (default: snakemake)
- `POSTGRES_PASSWORD`: PostgreSQL password (default: snakemake_password)
- `POSTGRES_DB`: PostgreSQL database name (default: snakemake_logs)
- `SQL_ECHO`: Enable SQL query logging (default: False)

## Development

### Setup

```bash
git clone <repository-url>
cd snakemake-logger-plugin-flowo
uv sync
```

### Build

```bash
uv build
```

## License

MIT License
