Metadata-Version: 2.4
Name: studyreg
Version: 0.1.0
Summary: Study Registry client — register, search, and manage reproducible computational studies
Project-URL: Homepage, https://github.com/K-RnD-Lab/SPHERE-III-TECHNOLOGY
Project-URL: Repository, https://github.com/K-RnD-Lab/SPHERE-III-TECHNOLOGY
Author: K-RnD-Lab
License-Expression: MIT
Keywords: computational-science,open-science,registry,reproducibility,studyreg
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Description-Content-Type: text/markdown

# studyreg

Study Registry client — register, search, and manage reproducible computational studies.

## Install

```bash
pip install studyreg
```

## Quick Start

```python
from studyreg import register, search, validate

# Register a new study
study = register(
    title="Oncology survival analysis with XGBoost",
    repo="https://github.com/example/oncology-study",
    tags=["oncology", "survival", "xgboost"],
    sphere="S",
)
# → {"id": "STU-0042", "status": "registered", ...}

# Search existing studies
results = search(domain="agriculture", status="completed")
# → [Study(...), Study(...)]

# Validate a study registration
validate(study)
# → {"valid": true, "warnings": []}
```

## API

### `register(title, repo, tags, sphere) -> dict`
Register a new computational study.

Returns dict with `id`, `status`, and registration metadata.

### `search(domain=None, status=None, tags=None, sphere=None) -> list[dict]`
Search registered studies by domain, status, tags, or sphere.

Returns list of matching study dicts.

### `validate(study: dict) -> dict`
Validate a study registration for completeness.

Returns `{"valid": bool, "warnings": list[str]}`.

## License

MIT © K-RnD-Lab
