Metadata-Version: 2.3
Name: szgf
Version: 0.1.4
Summary: ZZZ agent guides & definition of Standardized ZZZ Guide Format (SZGF)
Requires-Dist: aiofiles>=24.1.0
Requires-Dist: aiohttp>=3.12.13
Requires-Dist: hakushin-py>=0.4.11
Requires-Dist: loguru>=0.7.3
Requires-Dist: pydantic>=2.11.7
Requires-Dist: pyyaml>=6.0.2
Requires-Python: >=3.12
Description-Content-Type: text/markdown

# zzz-guides

This repository contains:

- ZZZ agent guides in `guides/original`
- Definition of the Standardized ZZZ Guide Format (SZGF) in `schema.json` (or as Pydantic models in `szgf/schema.py`)
- Python package for validating and fetching guides from this repository in `szgf`
- Parsed version of the guides in `guides/parsed`
- Translated guides in `guides/translated`

## Usage

Install the package:

```bash
pip install szgf
```

Import and use the `SZGFClient` to fetch and read guides:

```python
from szgf.client import SZGFClient
client = SZGFClient()
await client.download_guides()
guides = await client.read_guides() # Returns a dict of ParsedGuide objects
```

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for contribution guidelines.
