Metadata-Version: 2.4
Name: uniovi-simur-wearablepermed-models
Version: 1.2.0
Summary: Uniovi Simur WearablePerMed Models.
Home-page: https://github.com/SiMuR-UO/uniovi-simur-wearablepermed-models.git
Author: Miguel Salinas Gancedo
Author-email: masalinas.gancedo@gmail.com
License: MIT
Project-URL: Documentation, https://pyscaffold.org/
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
License-File: LICENSE.txt
Requires-Dist: importlib-metadata; python_version < "3.8"
Requires-Dist: cachetools==7.1.1
Requires-Dist: colorama==0.4.6
Requires-Dist: distlib==0.4.0
Requires-Dist: filelock==3.29.0
Requires-Dist: packaging==26.2
Requires-Dist: platformdirs==4.9.6
Requires-Dist: pluggy==1.6.0
Requires-Dist: pyproject-api==1.10.0
Requires-Dist: python-discovery==1.3.1
Requires-Dist: tomli_w==1.2.0
Requires-Dist: tox==4.54.0
Requires-Dist: virtualenv==21.3.3
Provides-Extra: testing
Requires-Dist: setuptools; extra == "testing"
Requires-Dist: pytest; extra == "testing"
Requires-Dist: pytest-cov; extra == "testing"
Dynamic: license-file

<!-- These are examples of badges you might want to add to your README:
     please update the URLs accordingly

[![Built Status](https://api.cirrus-ci.com/github/<USER>/uniovi-simur-wearablepermed-models.svg?branch=main)](https://cirrus-ci.com/github/<USER>/uniovi-simur-wearablepermed-models)
[![ReadTheDocs](https://readthedocs.org/projects/uniovi-simur-wearablepermed-models/badge/?version=latest)](https://uniovi-simur-wearablepermed-models.readthedocs.io/en/stable/)
[![Coveralls](https://img.shields.io/coveralls/github/<USER>/uniovi-simur-wearablepermed-models/main.svg)](https://coveralls.io/r/<USER>/uniovi-simur-wearablepermed-models)
[![PyPI-Server](https://img.shields.io/pypi/v/uniovi-simur-wearablepermed-models.svg)](https://pypi.org/project/uniovi-simur-wearablepermed-models/)
[![Conda-Forge](https://img.shields.io/conda/vn/conda-forge/uniovi-simur-wearablepermed-models.svg)](https://anaconda.org/conda-forge/uniovi-simur-wearablepermed-models)
[![Monthly Downloads](https://pepy.tech/badge/uniovi-simur-wearablepermed-models/month)](https://pepy.tech/project/uniovi-simur-wearablepermed-models)
[![Twitter](https://img.shields.io/twitter/url/http/shields.io.svg?style=social&label=Twitter)](https://twitter.com/uniovi-simur-wearablepermed-models)
-->

[![Project generated with PyScaffold](https://img.shields.io/badge/-PyScaffold-005CA0?logo=pyscaffold)](https://pyscaffold.org/)

# uniovi-simur-wearablepermed-models

> Uniovi Simur WearablePerMed Models.

A longer description of your project goes here...


<!-- pyscaffold-notes -->

# 1. Get all model types
```shell
$ models --list-types
```

# 2. Get all models inside a type
```shell
$ models --list-type-models mono_sensor
```

# 3. Get all models everywhere
```shell
$ models --list-all
```

# 4. Using the library to get models from code
A sample of use inside your code

```python
from wearablepermed_models.main import get_model_types, load_manifest, get_package_root
from pathlib import Path

def get_model_file_path(model_type: str, model_key: str) -> Path:
    """Returns the actual system file path of a pkl file using its registration key."""
    manifest = load_manifest(model_type)
    if model_key not in manifest:
        raise KeyError(f"Key '{model_key}' not found in model type '{model_type}'")
        
    filename = manifest[model_key]["filename"]
    return get_package_root() / model_type / filename

print(get_model_file_path('mono_sensor', 'model_1'))
```

## Note

This project has been set up using PyScaffold 4.6. For details and usage
information on PyScaffold see https://pyscaffold.org/.
