valohai-yaml


Namevalohai-yaml JSON
Version 0.49.0 PyPI version JSON
download
home_pageNone
SummaryValohai.yaml validation and parsing
upload_time2025-09-04 06:24:37
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords strings utility
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            # valohai-yaml

[![Build Status](https://github.com/valohai/valohai-yaml/actions/workflows/ci.yml/badge.svg)](https://github.com/valohai/valohai-yaml/actions/workflows/ci.yml)
[![Codecov](https://codecov.io/gh/valohai/valohai-yaml/branch/master/graph/badge.svg)](https://codecov.io/gh/valohai/valohai-yaml)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)

Parses and validates `valohai.yaml` files.

Valohai YAML files are used to define how your machine learning project workloads and pipelines are ran on the [Valohai](https://valohai.com/) ecosystem. Refer to [Valohai Documentation](https://docs.valohai.com/) to learn how to write the actual YAML files and for more in-depth usage examples.

## Installation

```bash
pip install valohai-yaml
```

## Usage

### Validation

Programmatic usage:

```python
from valohai_yaml import validate, ValidationErrors

try:
    with open('path/to/valohai.yaml') as f:
        validate(f)
except ValidationErrors as errors:
    print('oh no!')
    for err in errors:
        print(err)
```

Command-line usage:

```bash
valohai-yaml my_yaml.yaml
echo $?  # 1 if errors, 0 if ok
```

### Parsing

```python
from valohai_yaml import parse

with open('path/to/valohai.yaml') as f:
    config = parse(f)

print(config.steps['cool step'].command)
```

# Development

```bash
# setup development dependencies
make dev

# run linting and type checks
make lint

# run tests
make test
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "valohai-yaml",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "strings, utility",
    "author": null,
    "author_email": "Valohai <info@valohai.com>",
    "download_url": "https://files.pythonhosted.org/packages/a3/18/c97986998c2ca40a144e0d55f623756674dc47a9c6ef99dd0e7b3ba5a407/valohai_yaml-0.49.0.tar.gz",
    "platform": null,
    "description": "# valohai-yaml\n\n[![Build Status](https://github.com/valohai/valohai-yaml/actions/workflows/ci.yml/badge.svg)](https://github.com/valohai/valohai-yaml/actions/workflows/ci.yml)\n[![Codecov](https://codecov.io/gh/valohai/valohai-yaml/branch/master/graph/badge.svg)](https://codecov.io/gh/valohai/valohai-yaml)\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)\n\nParses and validates `valohai.yaml` files.\n\nValohai YAML files are used to define how your machine learning project workloads and pipelines are ran on the [Valohai](https://valohai.com/) ecosystem. Refer to [Valohai Documentation](https://docs.valohai.com/) to learn how to write the actual YAML files and for more in-depth usage examples.\n\n## Installation\n\n```bash\npip install valohai-yaml\n```\n\n## Usage\n\n### Validation\n\nProgrammatic usage:\n\n```python\nfrom valohai_yaml import validate, ValidationErrors\n\ntry:\n    with open('path/to/valohai.yaml') as f:\n        validate(f)\nexcept ValidationErrors as errors:\n    print('oh no!')\n    for err in errors:\n        print(err)\n```\n\nCommand-line usage:\n\n```bash\nvalohai-yaml my_yaml.yaml\necho $?  # 1 if errors, 0 if ok\n```\n\n### Parsing\n\n```python\nfrom valohai_yaml import parse\n\nwith open('path/to/valohai.yaml') as f:\n    config = parse(f)\n\nprint(config.steps['cool step'].command)\n```\n\n# Development\n\n```bash\n# setup development dependencies\nmake dev\n\n# run linting and type checks\nmake lint\n\n# run tests\nmake test\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Valohai.yaml validation and parsing",
    "version": "0.49.0",
    "project_urls": {
        "Homepage": "https://github.com/valohai/valohai-yaml"
    },
    "split_keywords": [
        "strings",
        " utility"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "3d72b48a277e0da9c90ad56a7529825952dc1f6fd7f6de2de7ed323fdbe5dbc6",
                "md5": "c64ee1357110ff57db32a86c889e8ac9",
                "sha256": "832d720ce7881bfd8c0c1a36b229658b52e2984492c259c89f8e156ca791f24e"
            },
            "downloads": -1,
            "filename": "valohai_yaml-0.49.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c64ee1357110ff57db32a86c889e8ac9",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 50185,
            "upload_time": "2025-09-04T06:24:36",
            "upload_time_iso_8601": "2025-09-04T06:24:36.201532Z",
            "url": "https://files.pythonhosted.org/packages/3d/72/b48a277e0da9c90ad56a7529825952dc1f6fd7f6de2de7ed323fdbe5dbc6/valohai_yaml-0.49.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "a318c97986998c2ca40a144e0d55f623756674dc47a9c6ef99dd0e7b3ba5a407",
                "md5": "b61a1603a7751c4a0fbe7008b2ba1461",
                "sha256": "6042e786be99c6a53647b2c564c6ad3812515a9dc0371219fa8c4f759be0d03c"
            },
            "downloads": -1,
            "filename": "valohai_yaml-0.49.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b61a1603a7751c4a0fbe7008b2ba1461",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 57305,
            "upload_time": "2025-09-04T06:24:37",
            "upload_time_iso_8601": "2025-09-04T06:24:37.579641Z",
            "url": "https://files.pythonhosted.org/packages/a3/18/c97986998c2ca40a144e0d55f623756674dc47a9c6ef99dd0e7b3ba5a407/valohai_yaml-0.49.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-04 06:24:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "valohai",
    "github_project": "valohai-yaml",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "valohai-yaml"
}
        
Elapsed time: 0.63439s