Skip to content

Commit 6bd8c78

Browse files
committed
Change: Update links and terms in README and docs
1 parent 98ac0c5 commit 6bd8c78

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,20 @@
44

55
[![GitHub releases](https://img.shields.io/github/release-pre/greenbone/python-gvm.svg)](https://github.com/greenbone/python-gvm/releases)
66
[![PyPI release](https://img.shields.io/pypi/v/python-gvm.svg)](https://pypi.org/project/python-gvm/)
7-
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/greenbone/python-gvm/badges/quality-score.png?b=main)](https://scrutinizer-ci.com/g/greenbone/python-gvm/?branch=main)
87
[![code test coverage](https://codecov.io/gh/greenbone/python-gvm/branch/main/graph/badge.svg)](https://codecov.io/gh/greenbone/python-gvm)
98
[![Build and test](https://github.com/greenbone/python-gvm/actions/workflows/ci-python.yml/badge.svg)](https://github.com/greenbone/python-gvm/actions/workflows/ci-python.yml)
109

1110
The Greenbone Vulnerability Management Python API library (**python-gvm**) is a
12-
collection of APIs that help with remote controlling a Greenbone Security
13-
Manager (GSM) appliance and its underlying Greenbone Vulnerability Manager
14-
(GVM). The library essentially abstracts accessing the communication protocols
15-
Greenbone Management Protocol (GMP) and Open Scanner Protocol (OSP).
11+
collection of APIs that help with remote controlling a Greenbone Enterprise
12+
Appliance and Greenbone Community installations. The library essentially
13+
abstracts accessing the communication protocols Greenbone Management Protocol
14+
(GMP) and Open Scanner Protocol (OSP).
1615

1716
## Table of Contents <!-- omit in toc -->
1817

1918
- [Documentation](#documentation)
2019
- [Installation](#installation)
20+
- [Version](#version)
2121
- [Requirements](#requirements)
2222
- [Install using pip](#install-using-pip)
2323
- [Example](#example)
@@ -29,7 +29,7 @@ Greenbone Management Protocol (GMP) and Open Scanner Protocol (OSP).
2929
## Documentation
3030

3131
The documentation for python-gvm can be found at
32-
[https://python-gvm.readthedocs.io/](https://python-gvm.readthedocs.io/en/latest/).
32+
[https://greenbone.github.io/python-gvm/](https://greenbone.github.io/python-gvm/).
3333
Please always take a look at the documentation for further details. This
3434
**README** just gives you a short overview.
3535

@@ -38,7 +38,7 @@ Please always take a look at the documentation for further details. This
3838
### Version
3939

4040
Please consider to always use the **newest** version of `gvm-tools` and `python-gvm`.
41-
We freqently update this projects to add features and keep them free from bugs.
41+
We frequently update this projects to add features and keep them free from bugs.
4242
This is why installing `python-gvm` using pip is recommended.
4343

4444
**To use `python-gvm` with an old GMP version (7, 8, 9) you must use a release version**
@@ -109,11 +109,15 @@ For development you should use [poetry](https://python-poetry.org)
109109
to keep you python packages separated in different environments. First install
110110
poetry via pip
111111

112-
python3 -m pip install --user poetry
112+
```shell
113+
python3 -m pip install --user poetry
114+
```
113115

114116
Afterwards run
115117

116-
poetry install
118+
```shell
119+
poetry install
120+
```
117121

118122
in the checkout directory of python-gvm (the directory containing the
119123
`pyproject.toml` file) to install all dependencies including the packages only
@@ -128,6 +132,6 @@ are active.
128132

129133
## License
130134

131-
Copyright (C) 2017-2021 [Greenbone Networks GmbH](https://www.greenbone.net/)
135+
Copyright (C) 2017-2022 [Greenbone Networks GmbH](https://www.greenbone.net/)
132136

133137
Licensed under the [GNU General Public License v3.0 or later](LICENSE).

docs/conf.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,6 @@
7373
# This pattern also affects html_static_path and html_extra_path.
7474
exclude_patterns = ["build", "dist", ".venv"]
7575

76-
# The name of the Pygments (syntax highlighting) style to use.
77-
pygments_style = None
78-
79-
8076
# -- Options for HTML output -------------------------------------------------
8177

8278
# The theme to use for HTML and HTML Help pages. See the documentation for

docs/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
python-gvm: Python API for the Greenbone Vulnerability Manager
2-
==============================================================
1+
python-gvm: Python API for Greenbone Vulnerability Management
2+
=============================================================
33

4-
**python-gvm** is the official python library to control the Greenbone
5-
Vulnerability Manager (GVM) remotely.
4+
**python-gvm** is the official python library to control a Greenbone Enterprise
5+
Appliance and Greenbone Community installations remotely.
66

77
.. note:: **python-gvm** requires at least Python 3.7. Python 2 is not supported.
88

pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ description = "Library to communicate with remote servers over GMP or OSP"
99
license = "GPL-3.0-or-later"
1010
authors = ["Greenbone Networks GmbH <info@greenbone.net>"]
1111
readme = "README.md"
12-
homepage = "https://github.com/greenbone/python-gvm"
13-
repository = "https://github.com/greenbone/python-gvm"
14-
documentation = "https://python-gvm.readthedocs.io/"
12+
homepage = "https://github.com/greenbone/python-gvm/"
13+
repository = "https://github.com/greenbone/python-gvm/"
14+
documentation = "https://greenbone.github.io/python-gvm/"
1515
classifiers = [
1616
# Full list: https://pypi.org/pypi?%3Aaction=list_classifiers
1717
"Development Status :: 5 - Production/Stable",

0 commit comments

Comments
 (0)