Metadata-Version: 2.1
Name: omnibench-cli
Version: 1.0.2
Summary: 
Home-page: https://renkulab.io/gitlab/btraven/omni-cli/
Author: btraven
Author-email: btraven@sdf.org
Requires-Python: >=3.8.1,<3.12
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: calamus (>=0.4.2,<0.5.0)
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: omnibenchmark (>=0.0.43,<0.0.44)
Requires-Dist: pydantic (>=1.10.2,<2.0.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: renku (>=2.3.2,<3.0.0)
Requires-Dist: requests (<2.28.2)
Requires-Dist: sparqlwrapper (>=2.0.0,<3.0.0)
Project-URL: Repository, https://renkulab.io/gitlab/btraven/omni-cli/
Description-Content-Type: text/markdown

# omni-cli

A command line interface to query and access datasets and workflows project-wide across omnibenchmark.

## Install

Install via pip:

```
pip install omnibench-cli
```

While developing, you can use poetry:

```
pip install poetry
poetry shell
```

## Use


```zsh
❯ omni_cli
Usage: omni_cli [OPTIONS] COMMAND [ARGS]...

  Interact with omnibenchmark datasets and workflows.

Options:
  --help  Show this message and exit.

Commands:
  bench     Inspect benchmarks
  dataset   Inspect datasets
  init      Initialize omnibenchmark cache
  update    Update omnibenchmark cache
  workflow  Interacts with workflows

❯ omni_cli bench ls
omni_clustering
spatial-clustering

❯ omni_cli bench stages omni_clustering
omni_clustering:build
omni_clustering:data_run
omni_clustering:process_run
omni_clustering:param_run
omni_clustering:method_run
omni_clustering:metric_run
omni_clustering:summary_run
```

## Useful pointers

* [Desired Features (WIP)](https://hackmd.io/_1CE5qDTTH6Zdgu5iZwp6g)
* [omnibenchmark-py](https://github.com/omnibenchmark/omnibenchmark-py/), a `python` library to interact with omnibenchmark.
* [omnibus](https://github.com/shdam/omnibus), a `bash/R` tool to interact with `omnibenchmark` from the terminal.
* [omni_site](https://renkulab.io/gitlab/omnibenchmark/omni_site), the static site generator that powers [https://omnibenchmark.org/](https://omnibenchmark.org/).

