Skip to main content

A project to parse klarf file and get klarf content as dataclass

Project description

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)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

klarf-reader-0.4.3.tar.gz (7.1 kB view hashes)

Uploaded Source

Built Distribution

klarf_reader-0.4.3-py3-none-any.whl (7.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page