Skip to content

Commit

Permalink
Change: Update README for supported Python versions and pip usage
Browse files Browse the repository at this point in the history
* Update copyright
* Run pip as module which avoids the pip vs pip3 issue
* Update supported Python versions (we dropped support for 3.7 and 3.8)
* Don't mention pipenv anymore
  • Loading branch information
bjoernricks committed Jan 13, 2023
1 parent c35afaa commit 8ef1258
Showing 1 changed file with 5 additions and 14 deletions.
19 changes: 5 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,42 +33,34 @@ The documentation for pontos can be found at https://greenbone.github.io/pontos/

### Requirements

Python 3.7 and later is supported.
Python 3.9 and later is supported.

### Install using pip

pip 19.0 or later is required.

> **Note**: All commands listed here use the general tool names. If some of
> these tools are provided by your distribution, you may need to explicitly use
> the Python 3 version of the tool, e.g. **`pip3`**.
You can install the latest stable release of **pontos** from the Python
Package Index (pypi) using [pip]

pip install --user pontos
python3 -m pip install --user pontos

### Install using poetry

Because **pontos** is a Python library you most likely need a tool to
handle Python package dependencies and Python environments. Therefore we
strongly recommend using [pipenv] or [poetry].
strongly recommend using [poetry].

You can install the latest stable release of **pontos** and add it as
a dependency for your current project using [poetry]

poetry add pontos

For installation via pipenv please take a look at their [documentation][pipenv].

## Development

**pontos** uses [poetry] for its own dependency management and build
process.

First install poetry via pip

pip install --user poetry
python3 -m pip install --user poetry

Afterwards run

Expand Down Expand Up @@ -101,12 +93,11 @@ first.

## License

Copyright (C) 2020-2022 [Greenbone Networks GmbH][Greenbone Networks]
Copyright (C) 2020-2023 [Greenbone Networks GmbH][Greenbone Networks]

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

[Greenbone Networks]: https://www.greenbone.net/
[poetry]: https://python-poetry.org/
[pip]: https://pip.pypa.io/
[pipenv]: https://pipenv.pypa.io/
[autohooks]: https://github.com/greenbone/autohooks

0 comments on commit 8ef1258

Please sign in to comment.