# puppetparser
puppetparser is a Python library to parse Puppet scripts. This parser allows the transformation of a Puppet script into an object model that represents the constructs of the Puppet DSL language.
## Installation
To install run:
```
pip install puppetparser
```
Or clone the GitHub repository and run:
```
poetry install
```
## Usage
```python
from puppetparser.parser import parse
with open(path) as f:
parsed_script, comments = parse_puppet(f.read())
```
## Tests
To run the tests:
```
python3 -m unittest discover tests
```
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)
Raw data
{
"_id": null,
"home_page": null,
"name": "puppetparser",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "puppet, parser, object model",
"author": "Nuno Saavedra",
"author_email": "nuno.saavedra@tecnico.ulisboa.pt",
"download_url": "https://files.pythonhosted.org/packages/cb/39/292daeefbd98d3a7ff56fc4ff8ad24fc13e86b3ec5b4eab98419ef976a02/puppetparser-0.2.4.tar.gz",
"platform": null,
"description": "# puppetparser\n\npuppetparser is a Python library to parse Puppet scripts. This parser allows the transformation of a Puppet script into an object model that represents the constructs of the Puppet DSL language.\n\n## Installation\n\nTo install run:\n```\npip install puppetparser\n```\n\nOr clone the GitHub repository and run:\n```\npoetry install\n```\n\n## Usage\n\n\n```python\nfrom puppetparser.parser import parse\n\nwith open(path) as f:\n parsed_script, comments = parse_puppet(f.read())\n```\n\n## Tests\n\nTo run the tests:\n```\npython3 -m unittest discover tests\n```\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n[GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/)\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "A parser from Puppet to an object model",
"version": "0.2.4",
"project_urls": {
"Bug Reports": "https://github.com/Nfsaavedra/puppetparser/issues",
"Source": "https://github.com/Nfsaavedra/puppetparser"
},
"split_keywords": [
"puppet",
" parser",
" object model"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "def523091fcc2d4ed959b21b9c588368e7a55758886d2514f3e2eae97679526e",
"md5": "7dc1bfcab02c8e727588e1ab5948c9e8",
"sha256": "3c625c7f8826f705b61c21aef5b59a759dd0ba79e72779ec9e664f900d8c713c"
},
"downloads": -1,
"filename": "puppetparser-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7dc1bfcab02c8e727588e1ab5948c9e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 23756,
"upload_time": "2024-03-23T11:57:16",
"upload_time_iso_8601": "2024-03-23T11:57:16.221724Z",
"url": "https://files.pythonhosted.org/packages/de/f5/23091fcc2d4ed959b21b9c588368e7a55758886d2514f3e2eae97679526e/puppetparser-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb39292daeefbd98d3a7ff56fc4ff8ad24fc13e86b3ec5b4eab98419ef976a02",
"md5": "1858be357f68bb49f4e4f6d675b0927d",
"sha256": "2db6273653e94f018582aa87da2780a5b7e2b2320cfa1485e312e4a16029accd"
},
"downloads": -1,
"filename": "puppetparser-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "1858be357f68bb49f4e4f6d675b0927d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 23222,
"upload_time": "2024-03-23T11:57:17",
"upload_time_iso_8601": "2024-03-23T11:57:17.446974Z",
"url": "https://files.pythonhosted.org/packages/cb/39/292daeefbd98d3a7ff56fc4ff8ad24fc13e86b3ec5b4eab98419ef976a02/puppetparser-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-23 11:57:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Nfsaavedra",
"github_project": "puppetparser",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "puppetparser"
}