| Name | glsr-present JSON |
| Version |
0.3.6
JSON |
| download |
| home_page | None |
| Summary | GitLab Security Reports Presenter |
| upload_time | 2024-11-26 07:37:35 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2023 Rainer Schwarzbach Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
gitlab-ci
security
reports
visualization
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# GitLab Security Reports Presenter
_Provide build information and pretty-printed GitLab security reports in a CI pipeline_
> * * *
> **⚠ Exposes found weaknesses and vulnerabilities**
>
> Publishing scan results can pose a security risk,
> consider using **glsr-present** in trusted environments only.
> * * *
> **Obsolete on Ultimate**
>
> If you are already on a [GitLab Ultimate] subscription,
> this package is superseded by the GitLab provided visualizations.
> * * *
## Usage options
### Installation from PyPI
``` bash
pip install glsr-present
```
[Jinja2] Version 3.1.2 (or newer) is required
and will be installed as an indirect dependency if not installed yet.
Installation in a virtual environment is strongly recommended.
### Run through uvx directly
If you already use [uv], you can simply run **glsr-present**
through **uvx** without prior install:
``` bash
uvx glsr-present
```
## Help message
Output of `glsr-present --help`:
``` text
usage: glsr-present [-h] [--version] [-d | -v | -q]
[-b TEMPLATE_NAME | -f TEMPLATE_PATH] [-l] [-n]
[-o DESTINATION] [-r DIRECTORY] [-s]
Provide build information and pretty-printed GitLab security reports in a CI
pipeline
options:
-h, --help show this help message and exit
--version print version and exit
-l, --list-templates list available templates and exit
-n, --dry-run no action (dry run): do not write any files
-o DESTINATION, --output-directory DESTINATION
write files to directory DESTINATION (default: docs)
-r DIRECTORY, --reports-path DIRECTORY
read reports from DIRECTORY (default:
/home/rainer/git/glsr-present)
-s, --skip-reports skip reading reports, just provide build information
Logging options:
control log level (default is WARNING)
-d, --debug output all messages (log level DEBUG)
-v, --verbose be more verbose (log level INFO)
-q, --quiet be more quiet (log level ERROR)
Template option:
Select a builtin template or one from the file system for the overview
page
-b TEMPLATE_NAME, --builtin-template TEMPLATE_NAME
use the built-in template TEMPLATE_NAME (default:
build-info.md.j2)
-f TEMPLATE_PATH, --template-file TEMPLATE_PATH
use the template from file TEMPLATE_PATH
```
## Further reading
Please see the documentation at <https://blackstream-x.gitlab.io/glsr-present>
for detailed usage information.
If you found a bug or have a feature suggestion,
please open an issue [here](https://gitlab.com/blackstream-x/glsr-present/-/issues)
* * *
[GitLab Ultimate]: https://about.gitlab.com/pricing/ultimate/
[Jinja2]: https://pypi.org/project/Jinja2/
[uv]: https://docs.astral.sh/uv/
Raw data
{
"_id": null,
"home_page": null,
"name": "glsr-present",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "gitlab-ci, security, reports, visualization",
"author": null,
"author_email": "Rainer Schwarzbach <undisclosed@example.com>",
"download_url": "https://files.pythonhosted.org/packages/10/c9/d22a52e95bd7c2026828d907e7a4ea64d2129ab052e6a3cd2e45833166d1/glsr_present-0.3.6.tar.gz",
"platform": null,
"description": "# GitLab Security Reports Presenter\n\n_Provide build information and pretty-printed GitLab security reports in a CI pipeline_\n\n> * * *\n> **\u26a0 Exposes found weaknesses and vulnerabilities**\n>\n> Publishing scan results can pose a security risk,\n> consider using **glsr-present** in trusted environments only.\n> * * *\n> **Obsolete on Ultimate**\n>\n> If you are already on a [GitLab Ultimate] subscription,\n> this package is superseded by the GitLab provided visualizations.\n> * * *\n\n\n\n## Usage options\n\n### Installation from PyPI\n\n``` bash\npip install glsr-present\n```\n\n[Jinja2] Version 3.1.2 (or newer) is required\n and will be installed as an indirect dependency if not installed yet.\n\nInstallation in a virtual environment is strongly recommended.\n\n\n### Run through uvx directly\n\nIf you already use [uv], you can simply run **glsr-present**\nthrough **uvx** without prior install:\n\n``` bash\nuvx glsr-present\n```\n\n\n## Help message\n\nOutput of `glsr-present --help`:\n\n``` text\nusage: glsr-present [-h] [--version] [-d | -v | -q]\n [-b TEMPLATE_NAME | -f TEMPLATE_PATH] [-l] [-n]\n [-o DESTINATION] [-r DIRECTORY] [-s]\n\nProvide build information and pretty-printed GitLab security reports in a CI\npipeline\n\noptions:\n -h, --help show this help message and exit\n --version print version and exit\n -l, --list-templates list available templates and exit\n -n, --dry-run no action (dry run): do not write any files\n -o DESTINATION, --output-directory DESTINATION\n write files to directory DESTINATION (default: docs)\n -r DIRECTORY, --reports-path DIRECTORY\n read reports from DIRECTORY (default:\n /home/rainer/git/glsr-present)\n -s, --skip-reports skip reading reports, just provide build information\n\nLogging options:\n control log level (default is WARNING)\n\n -d, --debug output all messages (log level DEBUG)\n -v, --verbose be more verbose (log level INFO)\n -q, --quiet be more quiet (log level ERROR)\n\nTemplate option:\n Select a builtin template or one from the file system for the overview\n page\n\n -b TEMPLATE_NAME, --builtin-template TEMPLATE_NAME\n use the built-in template TEMPLATE_NAME (default:\n build-info.md.j2)\n -f TEMPLATE_PATH, --template-file TEMPLATE_PATH\n use the template from file TEMPLATE_PATH\n```\n\n\n## Further reading\n\nPlease see the documentation at <https://blackstream-x.gitlab.io/glsr-present>\nfor detailed usage information.\n\nIf you found a bug or have a feature suggestion,\nplease open an issue [here](https://gitlab.com/blackstream-x/glsr-present/-/issues)\n\n\n* * *\n[GitLab Ultimate]: https://about.gitlab.com/pricing/ultimate/\n[Jinja2]: https://pypi.org/project/Jinja2/\n[uv]: https://docs.astral.sh/uv/\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Rainer Schwarzbach Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "GitLab Security Reports Presenter",
"version": "0.3.6",
"project_urls": {
"Bug Tracker": "https://gitlab.com/blackstream-x/glsr-present/-/issues",
"CI": "https://gitlab.com/blackstream-x/glsr-present/-/pipelines",
"Documentation": "https://blackstream-x.gitlab.io/glsr-present",
"Homepage": "https://gitlab.com/blackstream-x/glsr-present",
"Repository": "https://gitlab.com/blackstream-x/glsr-present.git"
},
"split_keywords": [
"gitlab-ci",
" security",
" reports",
" visualization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b7a6f1e38bd18640e9017a5757e46d54adeef3a76ce2e837c498a7c5167b6a5d",
"md5": "8f612b79eb677357d4341bb9abbb0961",
"sha256": "642ba4e7973f727ce6e4df069c9c498aac47490949b1a108d4db5144606db8a3"
},
"downloads": -1,
"filename": "glsr_present-0.3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8f612b79eb677357d4341bb9abbb0961",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 16177,
"upload_time": "2024-11-26T07:37:34",
"upload_time_iso_8601": "2024-11-26T07:37:34.504039Z",
"url": "https://files.pythonhosted.org/packages/b7/a6/f1e38bd18640e9017a5757e46d54adeef3a76ce2e837c498a7c5167b6a5d/glsr_present-0.3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "10c9d22a52e95bd7c2026828d907e7a4ea64d2129ab052e6a3cd2e45833166d1",
"md5": "b0fcff49352bd8f5471515fc43ddc922",
"sha256": "541785c115e422a4114ad839d4b44003f8dc186bb36062e31d5a01dd3186dd31"
},
"downloads": -1,
"filename": "glsr_present-0.3.6.tar.gz",
"has_sig": false,
"md5_digest": "b0fcff49352bd8f5471515fc43ddc922",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16320,
"upload_time": "2024-11-26T07:37:35",
"upload_time_iso_8601": "2024-11-26T07:37:35.483848Z",
"url": "https://files.pythonhosted.org/packages/10/c9/d22a52e95bd7c2026828d907e7a4ea64d2129ab052e6a3cd2e45833166d1/glsr_present-0.3.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-26 07:37:35",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "blackstream-x",
"gitlab_project": "glsr-present",
"lcname": "glsr-present"
}
