Metadata-Version: 2.4
Name: must-gather-parser
Version: 0.4.2
Summary: Asynchronous (multi) must-gather parsing library.
License-File: LICENSE
Author: Gabriel Meghnagi
Author-email: gabrielmeghnagi@outlook.com
Requires-Python: >=3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: aiofiles (>=25.1.0,<26.0.0)
Requires-Dist: pyyaml (>=6.0.3,<7.0.0)
Description-Content-Type: text/markdown

# must-gather-parser

[![Python Version](https://img.shields.io/pypi/pyversions/must-gather-parser.svg)](https://pypi.org/project/must-gather-parser/)
![publish workflow](https://github.com/gmeghnag/must-gather-parser/actions/workflows/publish.yml/badge.svg) 
![version](https://img.shields.io/pypi/v/must-gather-parser?label=version&color=green)

Asynchronous (multi) must-gather parsing library.

## INSTALL
```
pip install must-gather-parser
```

---

This module uses [**PyYAML**](https://github.com/yaml/pyyaml) for parsing YAML files.

For **significantly better performance**, PyYAML should be installed **with [libyaml](https://github.com/yaml/libyaml) support**.  
When available, PyYAML automatically uses its C-based loader, resulting in much faster YAML processing.

#### `libyaml` installation
```
# Debian / Ubuntu
sudo apt install libyaml-dev
```
```
# macOS
brew install libyaml
```
```
# Fedora
sudo dnf install libyaml-devel
```

## USAGE
```python
import asyncio
from must_gather_parser import MustGather
import json

must_gather = MustGather()

async def main():
    try:
        must_gather.use("/home/must-gather.local.1972254135986597168")
        x = await must_gather.get_resources(resource_kind_plural="pods", group="core", all_namespaces=True)
        print(json.dumps(x))
    except:
        must_gather.close()


if __name__ == "__main__":
    asyncio.run(main())
```

