| Name | pheme JSON |
| Version |
21.10.0
JSON |
| download |
| home_page | None |
| Summary | report-generation-service |
| upload_time | 2024-08-29 12:53:36 |
| maintainer | None |
| docs_url | None |
| author | Greenbone AG |
| requires_python | <4.0,>=3.9 |
| license | AGPL-3.0-or-later |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Pheme - Greenbone Static Report Generator <!-- omit in toc -->
[](https://github.com/greenbone/pheme/releases)
[](https://pypi.org/project/pheme/)
[](https://codecov.io/gh/greenbone/pheme)
[](https://github.com/greenbone/pheme/actions/workflows/ci-python.yml)
**pheme** is a service to create scan reports. It is maintained by [Greenbone AG][Greenbone AG].
[Pheme](https://en.wikipedia.org/wiki/Pheme) is the personification of fame and renown.
Or in this case personification of a service to generate reports.
## Table of Contents <!-- omit in toc -->
- [Installation](#installation)
- [Requirements](#requirements)
- [Development](#development)
- [Usage](#usage)
- [Maintainer](#maintainer)
- [Contributing](#contributing)
- [License](#license)
## Installation
### Requirements
Python 3.8 and later is supported.
Besides python `pheme` also needs to have
- libcairo2-dev
- pango1.0
installed.
## Development
**pheme** uses [poetry] for its own dependency management and build
process.
First install poetry via pip
python3 -m pip install --user poetry
Afterwards run
poetry install
in the checkout directory of **pheme** (the directory containing the
`pyproject.toml` file) to install all dependencies including the packages only
required for development.
Afterwards activate the git hooks for auto-formatting and linting via
[autohooks].
poetry run autohooks activate
Validate the activated git hooks by running
poetry run autohooks check
## Usage
In order to prepare the data structure the XML report data needs to be posted to `pheme` with a grouping indicator (either by host or nvt).
E.g.:
```
> curl -X POST 'http://localhost:8000/transform?grouping=nvt'\
-H 'Content-Type: application/xml'\
-H 'Accept: application/json'\
-d @test_data/longer_report.xml
"scanreport-nvt-9a233b0d-713c-4f22-9e15-f6e5090873e3"⏎
```
The returned identifier can be used to generate the actual report.
So far a report can be either in:
- application/json
- application/xml
- text/csv
E.g.
```
> curl -v 'http://localhost:8000/report/scanreport-nvt-9a233b0d-713c-4f22-9e15-f6e5090873e3' -H 'Accept: application/csv'
```
For visual report like
- application/pdf
- text/html
the corresponding css and html template needs to be put into pheme first:
```
> curl -X PUT localhost:8000/parameter\
-H 'x-api-key: SECRET_KEY_missing_using_default_not_suitable_in_production'\
--form vulnerability_report_html_css=@path_to_css_template\
--form vulnerability_report_pdf_css=@path_to_css_template\
--form vulnerability_report=@path_to_html_template
```
afterwards it can be get as usual:
```
> curl -v 'http://localhost:8000/report/scanreport-nvt-9a233b0d-713c-4f22-9e15-f6e5090873e3' -H 'Accept: application/pdf'
```
## Maintainer
This project is maintained by [Greenbone AG][Greenbone AG]
## Contributing
Your contributions are highly appreciated. Please
[create a pull request](https://github.com/greenbone/pheme/pulls)
on GitHub. Bigger changes need to be discussed with the development team via the
[issues section at GitHub](https://github.com/greenbone/pheme/issues)
first.
## License
Copyright (C) 2020-2023 [Greenbone AG][Greenbone AG]
Licensed under the [GNU Affero General Public License v3.0 or later](LICENSE).
[Greenbone AG]: https://www.greenbone.net/
[poetry]: https://python-poetry.org/
[autohooks]: https://github.com/greenbone/autohooks
Raw data
{
"_id": null,
"home_page": null,
"name": "pheme",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Greenbone AG",
"author_email": "info@greenbone.net",
"download_url": "https://files.pythonhosted.org/packages/2b/2a/a68694110677a1284ef5e770485aca4ac3bfb8e3b6e1deadc76c09791812/pheme-21.10.0.tar.gz",
"platform": null,
"description": "\n\n# Pheme - Greenbone Static Report Generator <!-- omit in toc -->\n\n[](https://github.com/greenbone/pheme/releases)\n [](https://pypi.org/project/pheme/)\n [](https://codecov.io/gh/greenbone/pheme)\n [](https://github.com/greenbone/pheme/actions/workflows/ci-python.yml)\n\n**pheme** is a service to create scan reports. It is maintained by [Greenbone AG][Greenbone AG].\n\n[Pheme](https://en.wikipedia.org/wiki/Pheme) is the personification of fame and renown.\n\nOr in this case personification of a service to generate reports.\n\n## Table of Contents <!-- omit in toc -->\n\n- [Installation](#installation)\n - [Requirements](#requirements)\n- [Development](#development)\n- [Usage](#usage)\n- [Maintainer](#maintainer)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Installation\n\n### Requirements\n\nPython 3.8 and later is supported.\n\nBesides python `pheme` also needs to have\n\n- libcairo2-dev\n- pango1.0\n\ninstalled.\n\n## Development\n\n**pheme** uses [poetry] for its own dependency management and build\nprocess.\n\nFirst install poetry via pip\n\n python3 -m pip install --user poetry\n\nAfterwards run\n\n poetry install\n\nin the checkout directory of **pheme** (the directory containing the\n`pyproject.toml` file) to install all dependencies including the packages only\nrequired for development.\n\nAfterwards activate the git hooks for auto-formatting and linting via\n[autohooks].\n\n poetry run autohooks activate\n\nValidate the activated git hooks by running\n\n poetry run autohooks check\n\n## Usage\n\nIn order to prepare the data structure the XML report data needs to be posted to `pheme` with a grouping indicator (either by host or nvt).\n\nE.g.:\n\n```\n> curl -X POST 'http://localhost:8000/transform?grouping=nvt'\\\n -H 'Content-Type: application/xml'\\\n -H 'Accept: application/json'\\\n -d @test_data/longer_report.xml\n\n \"scanreport-nvt-9a233b0d-713c-4f22-9e15-f6e5090873e3\"\u23ce\n```\n\nThe returned identifier can be used to generate the actual report.\n\nSo far a report can be either in:\n- application/json\n- application/xml\n- text/csv\nE.g.\n\n```\n> curl -v 'http://localhost:8000/report/scanreport-nvt-9a233b0d-713c-4f22-9e15-f6e5090873e3' -H 'Accept: application/csv'\n```\n\nFor visual report like\n\n- application/pdf\n- text/html\n\nthe corresponding css and html template needs to be put into pheme first:\n\n```\n> curl -X PUT localhost:8000/parameter\\\n -H 'x-api-key: SECRET_KEY_missing_using_default_not_suitable_in_production'\\\n --form vulnerability_report_html_css=@path_to_css_template\\\n --form vulnerability_report_pdf_css=@path_to_css_template\\\n --form vulnerability_report=@path_to_html_template\n```\n\nafterwards it can be get as usual:\n\n```\n> curl -v 'http://localhost:8000/report/scanreport-nvt-9a233b0d-713c-4f22-9e15-f6e5090873e3' -H 'Accept: application/pdf'\n```\n\n## Maintainer\n\nThis project is maintained by [Greenbone AG][Greenbone AG]\n\n## Contributing\n\nYour contributions are highly appreciated. Please\n[create a pull request](https://github.com/greenbone/pheme/pulls)\non GitHub. Bigger changes need to be discussed with the development team via the\n[issues section at GitHub](https://github.com/greenbone/pheme/issues)\nfirst.\n\n## License\n\nCopyright (C) 2020-2023 [Greenbone AG][Greenbone AG]\n\nLicensed under the [GNU Affero General Public License v3.0 or later](LICENSE).\n\n[Greenbone AG]: https://www.greenbone.net/\n[poetry]: https://python-poetry.org/\n[autohooks]: https://github.com/greenbone/autohooks\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0-or-later",
"summary": "report-generation-service",
"version": "21.10.0",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d265498274819f32def0d972bbf67ed826433ec4406010d5cfe56706eca9f431",
"md5": "7f8cac103035a4eedc4220a3e67ccb4a",
"sha256": "f0cc6102e63de686cc75b4d5a17d1909a4329a646cf4a864ba41a5c2b6784fa4"
},
"downloads": -1,
"filename": "pheme-21.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f8cac103035a4eedc4220a3e67ccb4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 54629,
"upload_time": "2024-08-29T12:53:35",
"upload_time_iso_8601": "2024-08-29T12:53:35.331551Z",
"url": "https://files.pythonhosted.org/packages/d2/65/498274819f32def0d972bbf67ed826433ec4406010d5cfe56706eca9f431/pheme-21.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2b2aa68694110677a1284ef5e770485aca4ac3bfb8e3b6e1deadc76c09791812",
"md5": "962a14d4ce48eec159dcc10ab342ae54",
"sha256": "67686f7f8efaed6f85c1136ce4dedb147d71cce53c7af108c8e390e25bba8e99"
},
"downloads": -1,
"filename": "pheme-21.10.0.tar.gz",
"has_sig": false,
"md5_digest": "962a14d4ce48eec159dcc10ab342ae54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 37332,
"upload_time": "2024-08-29T12:53:36",
"upload_time_iso_8601": "2024-08-29T12:53:36.354534Z",
"url": "https://files.pythonhosted.org/packages/2b/2a/a68694110677a1284ef5e770485aca4ac3bfb8e3b6e1deadc76c09791812/pheme-21.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-29 12:53:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pheme"
}
