Metadata-Version: 2.3
Name: lazyscribe-yaml
Version: 0.1.1
Summary: YAML-based artifact handler for Lazyscribe
Author: Akshay Gupta
Author-email: Akshay Gupta <akgcodes@gmail.com>
License: MIT license
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: attrs>=21.2,<=25.3
Requires-Dist: lazyscribe>=2.0.0a0,<=2.0.0a1
Requires-Dist: pyyaml>=5.4,<=6.0.3
Requires-Dist: commitizen ; extra == 'build'
Requires-Dist: uv ; extra == 'build'
Requires-Dist: lazyscribe-yaml[build] ; extra == 'dev'
Requires-Dist: lazyscribe-yaml[qa] ; extra == 'dev'
Requires-Dist: lazyscribe-yaml[tests] ; extra == 'dev'
Requires-Dist: edgetest ; extra == 'qa'
Requires-Dist: mypy ; extra == 'qa'
Requires-Dist: pre-commit ; extra == 'qa'
Requires-Dist: pyproject-fmt ; extra == 'qa'
Requires-Dist: ruff ; extra == 'qa'
Requires-Dist: types-python-slugify ; extra == 'qa'
Requires-Dist: types-pyyaml ; extra == 'qa'
Requires-Dist: uv ; extra == 'qa'
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: time-machine ; extra == 'tests'
Requires-Python: >=3.10.0
Project-URL: Documentation, https://github.com/lazyscribe/lazyscribe-yaml
Project-URL: Repository, https://github.com/lazyscribe/lazyscribe-yaml
Provides-Extra: build
Provides-Extra: dev
Provides-Extra: qa
Provides-Extra: tests
Description-Content-Type: text/markdown

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![PyPI](https://img.shields.io/pypi/v/lazyscribe-yaml)](https://pypi.org/project/lazyscribe-yaml/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/lazyscribe-yaml)](https://pypi.org/project/lazyscrib-yaml/) [![codecov](https://codecov.io/gh/lazyscribe/lazyscribe-yaml/graph/badge.svg?token=W5TPK7GX7G)](https://codecov.io/gh/lazyscribe/lazyscribe-yaml)

# YAML-based artifact handling for lazyscribe

`lazyscribe-yaml` is a lightweight package that adds the following artifact handlers for `lazyscribe`:

* `yaml`

# Installation

Python 3.10 or above is required. Use `pip` to install:

```console
$ python -m pip install lazyscribe-yaml
```

# Usage

To use this library, simply log an artifact to a `lazyscribe` experiment or repository with `handler="yaml"`.

```python
from lazyscribe import Project

project = Project("project.json", mode="w")
with project.log("My experiment") as exp:
    exp.log_artifact(name="feature-names", value=["a", "b", "c"], handler="yaml")

project.save()
```
