Metadata-Version: 2.1
Name: klarf-reader
Version: 0.4.3
Summary: A project to parse klarf file and get klarf content as dataclass
Home-page: https://github.com/Impro02/klarf_reader
Download-URL: https://github.com/Impro02/klarf_reader/archive/refs/tags/0.4.3.tar.gz
Author: Maxime MARTIN
Author-email: maxime.martin02@hotmail.fr
License: MIT
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Description-Content-Type: text/markdown
License-File: LICENSE.txt

The klarf-reader library is a python 3 lib that allow to parse and get klarf content as dataclass.

## Installing Karf-Reader

To install klarf-reader, if you already have Python, you can install with:

```
pip install klarf-reader
```

## How to import Karf-Reader

To access klarf-reader and its functions import it in your Python code like this:

```
from klarf_reader.klarf import Klarf
```

## Reading the example code

To reader a klarf file you just have to give the klarf path and klarf-reader will return you an instance of KlarfContent that contains information from klarf file.

```
path = Path('wd') / 'my_klarf_file'

content = Klarf.load_from_file(filepath=path)
```

You can also get raw contents from file.

```
path = Path('wd') / 'my_klarf_file'

content, raw_content = Klarf.load_from_file_with_raw_content(filepath=path)
```
