diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 17 |
1 files changed, 17 insertions, 0 deletions
@@ -5,9 +5,26 @@ A simple ORM-like utility for operating on local YAML files via Python dataclass Define a dataclass: ```python +from dataclasses import dataclass + @dataclass class User: name: str age: int active: bool ``` + +Instantiate a new object: + +```python +user = User(name="yuval", age=42, active=True) +``` + +Save it to file: + +```python +from ymlstash import YmlStash + +stash = YmlStash("path/to/db") +stash.save(user) +``` |
