Skip to content

Commit 07ec91f

Browse files
mathieubellonsevbch
authored andcommitted
Update section in README for Python support
docs: clarify requirements for Docker and Pypi commands in README docs: Doctoc update
1 parent c405695 commit 07ec91f

File tree

1 file changed

+7
-17
lines changed

1 file changed

+7
-17
lines changed

README.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ Only metadata such as call time, request size and scan mode is stored from scans
2323
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
2424

2525
- [Installation](#installation)
26-
- [Requirements](#requirements)
2726
- [macOS](#macos)
2827
- [Homebrew](#homebrew)
2928
- [Standalone .pkg package](#standalone-pkg-package)
@@ -55,27 +54,14 @@ ggshield" section of the "Getting started" page of ggshield public
5554
documentation.
5655
-->
5756

58-
## Requirements
59-
60-
`ggshield` works on macOS, Linux and Windows.
61-
62-
It requires **Python 3.8 or above** (except for standalone packages) and git.
63-
64-
⚠️ Python 3.8 is no longer supported by the Python Software Foundation since October, 14th 2024. GGShield will soon require Python 3.9 or above to run.
65-
66-
Some commands require additional programs:
67-
68-
- docker: to scan docker images.
69-
- pip: to scan pypi packages.
70-
7157
## macOS
7258

7359
### Homebrew
7460

7561
You can install `ggshield` using Homebrew:
7662

7763
```shell
78-
$ brew install gitguardian/tap/ggshield
64+
$ brew install ggshield
7965
```
8066

8167
Upgrading is handled by Homebrew.
@@ -113,6 +99,10 @@ This archive _does not_ require installing Python, but you have to manually down
11399

114100
`ggshield` can be installed on all supported operating systems via its [PyPI package](https://pypi.org/project/ggshield).
115101

102+
It requires **a supported version of Python (not EOL)** (except for standalone packages) and git.
103+
104+
If you don't use our packaged versions of `ggshield`, please be aware that we follow the [Python release cycle](https://devguide.python.org/versions/) and do not support versions that have reached EOL.
105+
116106
### Using pipx
117107

118108
The recommended way to install `ggshield` from PyPI is to use [pipx](https://pypa.github.io/pipx/), which will install it in an isolated environment:
@@ -161,8 +151,8 @@ You can now use `ggshield` to search for secrets:
161151

162152
- in files: `ggshield secret scan path -r .`
163153
- in repositories: `ggshield secret scan repo .`
164-
- in Docker images: `ggshield secret scan docker ubuntu:22.04`
165-
- in Pypi packages: `ggshield secret scan pypi flask`
154+
- in Docker images (`docker` command must be available): `ggshield secret scan docker ubuntu:22.04`
155+
- in Pypi packages (`pip` command must be available): `ggshield secret scan pypi flask`
166156
- and more, have a look at `ggshield secret scan --help` output for details.
167157

168158
# Integrations

0 commit comments

Comments
 (0)