Metadata-Version: 2.4
Name: varvis-connector
Version: 0.2.2.post1
Summary: A Python package and CLI tool for interacting with the Varvis® API.
Keywords: api,varvis,cli
Author: Markus Konrad, Bernt Popp
Author-email: Markus Konrad <markus.konrad@laborberlin.com>, Bernt Popp <bernt.popp@laborberlin.com>
License-Expression: GPL-3.0-only
License-File: LICENSE
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Healthcare Industry
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Dist: pydantic>=2.13.4
Requires-Dist: requests>=2.34.2
Requires-Dist: tqdm>=4.67.3
Requires-Python: >=3.10
Project-URL: Homepage, https://github.com/LaborBerlin/varvis-connector
Project-URL: Documentation, https://laborberlin.github.io/varvis-connector/
Project-URL: Repository, https://github.com/LaborBerlin/varvis-connector
Project-URL: Issues, https://github.com/LaborBerlin/varvis-connector/issues
Project-URL: Changelog, https://github.com/LaborBerlin/varvis-connector/blob/master/CHANGELOG.md
Description-Content-Type: text/markdown

# varvis® API Python package

![CI testing pipeline](https://github.com/LaborBerlin/varvis-connector/actions/workflows/tests.yaml/badge.svg)
![CI code quality
pipeline](https://github.com/LaborBerlin/varvis-connector/actions/workflows/codequality.yaml/badge.svg)
![Test coverage](https://github.com/LaborBerlin/varvis-connector/raw/refs/heads/badges/pr/pr-latest.svg)

Authors: Markus Konrad <markus.konrad@laborberlin.com>, Bernt Popp <bernt.popp@laborberlin.com>

## Summary

<p align="center">
<img
    alt="varvis logo"
    src="https://github.com/LaborBerlin/varvis-connector/raw/main/docs/source/_static/varvis_name.svg"
    style="width:25%; height:auto;">
</p>

The `varvis-connector` package provides a Python interface for the varvis® API. It includes both a command-line interface
(CLI) and a Python package with a client implementation. The package handles authentication, session management, and
provides methods to retrieve various types of genomic data including SNV annotations, CNV target results, and CNV
segments. It supports environment-based configuration and includes comprehensive error handling.

## Intended Use

This software is provided solely for research, educational, development, interoperability, and bioinformatics workflow
automation purposes.

This project is NOT intended by the authors to be used for:

- clinical diagnosis,
- in vitro diagnostic procedures,
- patient stratification,
- treatment selection,
- medical decision-making,
- or any other medical purpose as defined under applicable medical device or in vitro diagnostic regulations, including
  but not limited to Regulation (EU) 2017/746 (IVDR).

The software is not a certified in vitro diagnostic medical device and has not undergone clinical performance studies,
regulatory assessment, or conformity assessment procedures required for software intended for in vitro diagnostic use.

Users are solely responsible for ensuring compliance with all applicable laws, regulations, institutional policies,
and validation requirements in their jurisdiction and use case.

## License

This project is licensed under the GNU General Public License v3.0 (GPLv3).
See the LICENSE file for details.

## Documentation

The full documentation for this project is available at
[laborberlin.github.io/varvis-connector/](https://laborberlin.github.io/varvis-connector/)

It covers:

- Requirements and installation
- Configuration and environment variables
- Usage guide for the CLI and the Python package
- Python package API documentation
- Development guide
- Changelog

## Disclaimer

The varvis® logo is a registered trademark of Limbus Medical Technologies GmbH and is used in this project with
permission. This project is independent and is not affiliated with, endorsed by, or officially supported by Limbus
Medical Technologies GmbH.
