diff --git a/.github/workflows/pythonpublish.yml b/.github/workflows/pythonpublish.yml index 4747664..03336d1 100644 --- a/.github/workflows/pythonpublish.yml +++ b/.github/workflows/pythonpublish.yml @@ -20,7 +20,7 @@ jobs: - name: Build release distributions run: | - python -m pip install build setuptools + python -m pip install --upgrade pip build setuptools python -m build - name: Upload distributions diff --git a/README.md b/README.md index d5c9104..90c36cb 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,8 @@ [![Docs](https://readthedocs.org/projects/openvas-reporting/badge/?version=latest&style=flat)](https://openvas-reporting.sequr.be) [![PyPI - Version](https://img.shields.io/pypi/v/OpenVAS-Reporting.svg)](https://pypi.org/project/OpenVAS-Reporting/) [![PyPI - Format](https://img.shields.io/pypi/format/OpenVAS-Reporting.svg)](https://pypi.org/project/OpenVAS-Reporting/) -[![Total alerts](https://img.shields.io/lgtm/alerts/g/TheGroundZero/openvasreporting.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/TheGroundZero/openvasreporting/alerts/) -[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/TheGroundZero/openvasreporting.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/TheGroundZero/openvasreporting/context:python) [![Known Vulnerabilities](https://snyk.io/test/github/TheGroundZero/openvasreporting/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/TheGroundZero/openvasreporting?targetFile=requirements.txt) [![codecov](https://codecov.io/gh/TheGroundZero/openvasreporting/branch/master/graph/badge.svg)](https://codecov.io/gh/TheGroundZero/openvasreporting) -[![Requirements Status](https://requires.io/github/TheGroundZero/openvasreporting/requirements.svg?branch=master)](https://requires.io/github/TheGroundZero/openvasreporting/requirements/?branch=master) A tool to convert [OpenVAS](http://www.openvas.org/) XML into reports. diff --git a/docs/index.rst b/docs/index.rst index 4f52a1a..98467d3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,7 +2,7 @@ OpenVAS Reporting ================= |version| |license| |docs| |pypi_version| |pypi_format| -|alerts| |grade| |vulns| |codecov| |requires| +|vulns| |codecov| A tool to convert OpenVAS XML into reports. @@ -96,17 +96,8 @@ TODO list .. |pypi_version| image:: https://img.shields.io/pypi/v/OpenVAS-Reporting.svg :alt: PyPI - Version :target: https://pypi.org/project/OpenVAS-Reporting/ -.. |requires| image:: https://requires.io/github/TheGroundZero/openvasreporting/requirements.svg?branch=master - :target: https://requires.io/github/TheGroundZero/openvasreporting/requirements/?branch=master - :alt: Requirements Status .. |version| image:: https://badge.fury.io/gh/TheGroundZero%2Fopenvasreporting.svg :target: https://badge.fury.io/gh/TheGroundZero%2Fopenvasreporting .. |vulns| image:: https://snyk.io/test/github/TheGroundZero/openvasreporting/badge.svg?targetFile=requirements.txt :alt: Known Vulnerabilities :target: https://snyk.io/test/github/TheGroundZero/openvasreporting?targetFile=requirements.txt -.. |alerts| image:: https://img.shields.io/lgtm/alerts/g/TheGroundZero/openvasreporting.svg?logo=lgtm&logoWidth=18 - :alt: Total alerts - :target: https://lgtm.com/projects/g/TheGroundZero/openvasreporting/alerts/ -.. |grade| image:: https://img.shields.io/lgtm/grade/python/g/TheGroundZero/openvasreporting.svg?logo=lgtm&logoWidth=18 - :alt: Language Grade: Python - :target: https://lgtm.com/projects/g/TheGroundZero/openvasreporting/context:python diff --git a/pyproject.toml b/pyproject.toml index 1870a2e..379933b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,3 +2,61 @@ requires = ["setuptools", "wheel"] build-backend = "setuptools.build_meta" +[project] +name = "openvasreporting" +dependencies = [ + "xlsxwriter>=1.0.0", + "python-docx>=0.8.7", + "matplotlib>=2.2.2", + "netaddr>=0.8.0" +] +requires-python = ">= 3.12" +authors = [ + {name = "TheGroundZero", email = "2406013+TheGroundZero@users.noreply.github.com"} +] +maintainers = [ + {name = "BEduardo Ferreira (@dudacgf)"} +] +description = "A tool to convert OpenVAS XML into reports." +readme = {file = "README.md", content-type = "text/markdown"} +license = {file = "LICENSE"} +keywords = ["OpenVAS", "OpenVAS-reports", "Excel", "xlsxwriter", "xlsx", "reporting", "reports", "report"] +classifiers = [ + "Development Status :: 5 - Production/Stable", + "Environment :: Console", + "Framework :: Sphinx", + "Intended Audience :: Developers", + "Intended Audience :: End Users/Desktop", + "Intended Audience :: Information Technology", + "Intended Audience :: Other Audience", + "Intended Audience :: System Administrators", + "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", + "Natural Language :: English", + "Operating System :: MacOS", + "Operating System :: Microsoft :: Windows", + "Operating System :: POSIX", + "Operating System :: Unix", + "Programming Language :: Python", + "Topic :: Documentation :: Sphinx", + "Topic :: Internet :: Log Analysis", + "Topic :: Security" +] +dynamic = ["version"] + +[project.urls] +Repository = "https://github.com/TheGroundZero/openvasreporting" +Documentation = "https://openvas-reporting.sequr.be" +Issues = "https://github.com/TheGroundZero/openvasreporting/issues/" +Changelog = "https://github.com/TheGroundZero/openvasreporting/blob/main/CHANGELOG" + +[project.scripts] +openvasreporting = "openvasreporting:main" + +[tool.setuptools] +include-package-data = true + +[tool.setuptools.package-data] +openvasreporting = ["src/openvas-template.docx"] + +[tool.setuptools.packages.find] +include = ["openvasreporting", "openvasreporting.libs"] diff --git a/requirements.txt b/requirements.txt index 5bfa274..bb8f5bf 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,7 +1,7 @@ ## you don't need this file to build the package. but for development reasons... build>=0.7.0 cycler>=0.11.0 -kiwisolver>=1.3. +kiwisolver>=1.3 defusedxml>=0.7.1 matplotlib>=3.4.3 netaddr>=0.8.0 diff --git a/setup.cfg b/setup.cfg.bak similarity index 98% rename from setup.cfg rename to setup.cfg.bak index f30cb18..6114cef 100644 --- a/setup.cfg +++ b/setup.cfg.bak @@ -1,5 +1,5 @@ [metadata] -name = OpenVAS Reporting +name = openvasreporting version = 1.6.1 description = A tool to convert OpenVAS XML into reports. long_description = file: README.md, LICENSE, CHANGELOG