Metadata-Version: 2.4
Name: insdc-benchmarking-schema
Version: 1.2.0
Summary: JSON schema and validation for INSDC benchmarking results
License: Apache-2.0
License-File: LICENSE
Keywords: insdc,benchmarking,genomics,data-transfer
Author: Australian BioCommons
Author-email: guerdon@biocommons.org.au
Requires-Python: >=3.9,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
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.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: jsonschema (>=4.20.0,<5.0.0)
Requires-Dist: pydantic (>=2.5.0,<3.0.0)
Project-URL: Homepage, https://github.com/AustralianBioCommons/insdc-benchmarking-schema
Project-URL: Repository, https://github.com/AustralianBioCommons/insdc-benchmarking-schema
Description-Content-Type: text/markdown

# INSDC Benchmarking Schema

Python package providing JSON schema and validation for INSDC benchmarking results.

## Installation

```bash
pip install insdc-benchmarking-schema
```

## Quick Start

```python
from insdc_benchmarking_schema import BenchmarkResult

result = BenchmarkResult(
    timestamp="2025-01-15T14:30:00Z",
    site="nci",
    protocol="globus",
    repository="ENA",
    dataset_id="SRR12345678",
    duration_sec=42.7,
    file_size_bytes=104857600,
    average_speed_mbps=950.5,
    status="success",
    checksum_md5="d41d8cd98f00b204e9800998ecf8427e"
)

print(result.model_dump_json(indent=2))
```

See full documentation in the repository.

