klarf-reader

Name	klarf-reader JSON
Version	0.4.3 JSON
	download
home_page	https://github.com/Impro02/klarf_reader
Summary	A project to parse klarf file and get klarf content as dataclass
upload_time	2023-08-23 07:13:45
maintainer
docs_url	None
author	Maxime MARTIN
requires_python
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            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)
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/Impro02/klarf_reader",
    "name": "klarf-reader",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "Maxime MARTIN",
    "author_email": "maxime.martin02@hotmail.fr",
    "download_url": "https://files.pythonhosted.org/packages/79/40/ac2aff09ff6431e86e9eaf13b6d428bce9604cfff3fc0015ed11a11b0eaa/klarf-reader-0.4.3.tar.gz",
    "platform": null,
    "description": "The klarf-reader library is a python 3 lib that allow to parse and get klarf content as dataclass.\n\n## Installing Karf-Reader\n\nTo install klarf-reader, if you already have Python, you can install with:\n\n```\npip install klarf-reader\n```\n\n## How to import Karf-Reader\n\nTo access klarf-reader and its functions import it in your Python code like this:\n\n```\nfrom klarf_reader.klarf import Klarf\n```\n\n## Reading the example code\n\nTo 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.\n\n```\npath = Path('wd') / 'my_klarf_file'\n\ncontent = Klarf.load_from_file(filepath=path)\n```\n\nYou can also get raw contents from file.\n\n```\npath = Path('wd') / 'my_klarf_file'\n\ncontent, raw_content = Klarf.load_from_file_with_raw_content(filepath=path)\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A project to parse klarf file and get klarf content as dataclass",
    "version": "0.4.3",
    "project_urls": {
        "Download": "https://github.com/Impro02/klarf_reader/archive/refs/tags/0.4.3.tar.gz",
        "Homepage": "https://github.com/Impro02/klarf_reader"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4d860b0a1e1673330707d615179dd6f6dfa7db6f7dd992b52b5c5775f83fe230",
                "md5": "440d520c9df92417ebd69691956af703",
                "sha256": "4b6562263c32f248d43197ce69ebae415157d15449d0704c638ab8b06d75782c"
            },
            "downloads": -1,
            "filename": "klarf_reader-0.4.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "440d520c9df92417ebd69691956af703",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7825,
            "upload_time": "2023-08-23T07:13:43",
            "upload_time_iso_8601": "2023-08-23T07:13:43.882643Z",
            "url": "https://files.pythonhosted.org/packages/4d/86/0b0a1e1673330707d615179dd6f6dfa7db6f7dd992b52b5c5775f83fe230/klarf_reader-0.4.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "7940ac2aff09ff6431e86e9eaf13b6d428bce9604cfff3fc0015ed11a11b0eaa",
                "md5": "412ec67a577d74684a0aff2eb1c9ace2",
                "sha256": "dd2fb96726bb540c98b1e85b8fca3247a558e90bd277557c0085d64298474171"
            },
            "downloads": -1,
            "filename": "klarf-reader-0.4.3.tar.gz",
            "has_sig": false,
            "md5_digest": "412ec67a577d74684a0aff2eb1c9ace2",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7114,
            "upload_time": "2023-08-23T07:13:45",
            "upload_time_iso_8601": "2023-08-23T07:13:45.362327Z",
            "url": "https://files.pythonhosted.org/packages/79/40/ac2aff09ff6431e86e9eaf13b6d428bce9604cfff3fc0015ed11a11b0eaa/klarf-reader-0.4.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-23 07:13:45",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "Impro02",
    "github_project": "klarf_reader",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "klarf-reader"
}