# perceval-puppet [](https://github.com/chaoss/grimoirelab-perceval-puppet/actions?query=workflow:tests+branch:master+event:push) [](https://coveralls.io/r/chaoss/grimoirelab-perceval-puppet?branch=master) [](https://badge.fury.io/py/perceval-puppet)
Bundle of Perceval backends for Puppet ecosystem.
## Backends
The backends currently managed by this package support the next repositories:
* Puppet Forge
## Requirements
* Python >= 3.8
You will also need some other libraries for running the tool, you can find the
whole list of dependencies in [pyproject.toml](pyproject.toml) file.
## Installation
There are several ways to install perceval-puppet on your system: packages or source
code using Poetry or pip.
### PyPI
perceval-puppet can be installed using pip, a tool for installing Python packages.
To do it, run the next command:
```
$ pip install perceval-puppet
```
### Source code
To install from the source code you will need to clone the repository first:
```
$ git clone https://github.com/chaoss/grimoirelab-perceval-puppet
$ cd grimoirelab-perceval-puppet
```
Then use pip or Poetry to install the package along with its dependencies.
#### Pip
To install the package from local directory run the following command:
```
$ pip install .
```
In case you are a developer, you should install perceval-puppet in editable mode:
```
$ pip install -e .
```
#### Poetry
We use [poetry](https://python-poetry.org/) for dependency management and
packaging. You can install it following its [documentation](https://python-poetry.org/docs/#installation).
Once you have installed it, you can install perceval-puppet and the dependencies in
a project isolated environment using:
```
$ poetry install
```
To spaw a new shell within the virtual environment use:
```
$ poetry shell
```
## Examples
### Puppet Forge
```
$ perceval puppetforge
```
## License
Licensed under GNU General Public License (GPL), version 3 or later.
Raw data
{
"_id": null,
"home_page": "https://chaoss.github.io/grimoirelab/",
"name": "perceval-puppet",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "development, grimoirelab",
"author": "GrimoireLab Developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/84/1d/1b596e02a30e8233044e3bac12785f1d802a21613fd477aeca153539155c/perceval_puppet-1.0.0.tar.gz",
"platform": null,
"description": "# perceval-puppet [](https://github.com/chaoss/grimoirelab-perceval-puppet/actions?query=workflow:tests+branch:master+event:push) [](https://coveralls.io/r/chaoss/grimoirelab-perceval-puppet?branch=master) [](https://badge.fury.io/py/perceval-puppet)\n\nBundle of Perceval backends for Puppet ecosystem.\n\n## Backends\n\nThe backends currently managed by this package support the next repositories:\n\n* Puppet Forge\n\n## Requirements\n\n * Python >= 3.8\n\nYou will also need some other libraries for running the tool, you can find the\nwhole list of dependencies in [pyproject.toml](pyproject.toml) file.\n\n## Installation\n\nThere are several ways to install perceval-puppet on your system: packages or source \ncode using Poetry or pip.\n\n### PyPI\n\nperceval-puppet can be installed using pip, a tool for installing Python packages. \nTo do it, run the next command:\n```\n$ pip install perceval-puppet\n```\n\n### Source code\n\nTo install from the source code you will need to clone the repository first:\n```\n$ git clone https://github.com/chaoss/grimoirelab-perceval-puppet\n$ cd grimoirelab-perceval-puppet\n```\n\nThen use pip or Poetry to install the package along with its dependencies.\n\n#### Pip\nTo install the package from local directory run the following command:\n```\n$ pip install .\n```\nIn case you are a developer, you should install perceval-puppet in editable mode:\n```\n$ pip install -e .\n```\n\n#### Poetry\nWe use [poetry](https://python-poetry.org/) for dependency management and \npackaging. You can install it following its [documentation](https://python-poetry.org/docs/#installation).\nOnce you have installed it, you can install perceval-puppet and the dependencies in \na project isolated environment using:\n```\n$ poetry install\n```\nTo spaw a new shell within the virtual environment use:\n```\n$ poetry shell\n```\n\n## Examples\n\n### Puppet Forge\n\n```\n$ perceval puppetforge\n```\n\n## License\n\nLicensed under GNU General Public License (GPL), version 3 or later.\n",
"bugtrack_url": null,
"license": "GPL-3.0+",
"summary": "Bundle of Perceval backends for Puppet, Inc. ecosystem.",
"version": "1.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/chaoss/grimoirelab-perceval-puppet/issues",
"Homepage": "https://chaoss.github.io/grimoirelab/",
"Repository": "https://github.com/chaoss/grimoirelab-perceval-puppet"
},
"split_keywords": [
"development",
" grimoirelab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "858fd4f9b5ddb359c016b4892763e6d9c2d85fed9a2d94c8c0203d7fd8e8ee14",
"md5": "56d5b6c0c9c4be85a6812291095c39ef",
"sha256": "16d2132295066f4873dedb756d6f7717b5f727d43707c723a9a55f8b6313260d"
},
"downloads": -1,
"filename": "perceval_puppet-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "56d5b6c0c9c4be85a6812291095c39ef",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 18461,
"upload_time": "2024-04-13T07:31:58",
"upload_time_iso_8601": "2024-04-13T07:31:58.037242Z",
"url": "https://files.pythonhosted.org/packages/85/8f/d4f9b5ddb359c016b4892763e6d9c2d85fed9a2d94c8c0203d7fd8e8ee14/perceval_puppet-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "841d1b596e02a30e8233044e3bac12785f1d802a21613fd477aeca153539155c",
"md5": "e2ba417541f1a61bf81a4483ed198137",
"sha256": "4b1ea8f91cf27872ca2eb14dd9b7387cdb503e5bf3ea58b3e54bef0b53c46fc5"
},
"downloads": -1,
"filename": "perceval_puppet-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e2ba417541f1a61bf81a4483ed198137",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 28411,
"upload_time": "2024-04-13T07:31:59",
"upload_time_iso_8601": "2024-04-13T07:31:59.280615Z",
"url": "https://files.pythonhosted.org/packages/84/1d/1b596e02a30e8233044e3bac12785f1d802a21613fd477aeca153539155c/perceval_puppet-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-13 07:31:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chaoss",
"github_project": "grimoirelab-perceval-puppet",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "perceval-puppet"
}
JSON
