Metadata-Version: 2.4
Name: ogn-sdk
Version: 0.9.1
Summary: Thin helpers for launching local OGN runs and calling the OGN control plane
Author-email: OGN <support@ogn.ai>
License: Apache-2.0
Project-URL: Homepage, https://github.com/omniscoder/ogn-core-kit
Project-URL: Issues, https://github.com/omniscoder/ogn-core-kit/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: grpcio>=1.62
Requires-Dist: protobuf>=4.25
Requires-Dist: typing-extensions>=4.0
Provides-Extra: dev
Requires-Dist: jsonschema>=4.0; extra == "dev"
Requires-Dist: pytest>=7.0; extra == "dev"

# ogn-sdk (Python)

`ogn-sdk` is a tiny convenience layer around the `ogn_run` binary. Install it with:

```bash
python3 -m pip install ogn-sdk
```

Example usage:

```python
from ogn_sdk import RunRequest, run_local

req = RunRequest(
    fastq="/data/sample_R1.fastq.gz",
    reference="/data/ref.fa",
    output_vcf="out/sample.g.vcf.gz",
    sample_id="hg002_chr20",
    profile_dir="profile_hg002"
)

result = run_local(req)
print("exit status", result.returncode)
```

`RunRequest` maps directly to CLI flags, so you can pass `fastq2`, `bundle`, or
any additional CLI switches via `extra_args`. The helper simply shells out to
`ogn_run` (defaulting to the binary on `PATH`).
