How to install ggshield via python pip

ggshield - Detect secrets from all sources using GitGuardian's brains, it belongs to Classifiers:

- Development Status :: 5 - Production/Stable
- Environment :: Console
- Intended Audience :: End Users/Desktop
- Natural Language :: English
- Topic :: Security

When you know about this project and you want to new install ggshield to support your project or you get trouble as ModuleNotFoundError: No module named "ggshield" or ImportError: cannot import name "ggshield" in your project, let follow this tutorial to install ggshield

Installation:

Step 1: First, ensure you installed pip in your os, to check pip has been installed on your computer

In Windows (CMD):

py -m pip --version

In Unix/macOS:

python3 -m pip --version

Ensure pip, setuptools, and wheel are up to date:

In Windows (CMD):

py -m pip install --upgrade pip setuptools wheel

In Unix/macOS:

python3 -m pip install --upgrade pip setuptools wheel

Optional - If you want to install in virtual environment:

In Windows (CMD):

- Install virtualenv - if you installed it, please ignore

py -m pip install --user virtualenv

- Create a virtual environment

py -m venv test_ggshield_env

- Active the virtual environment

test_ggshield_env\Scripts\active

In Unix/macOS:

- Install virtualenv - if you installed it, please ignore

pip3 install virtualenv

- Create a virtual environment

python3 -m venv test_ggshield_env

- Active the virtual environment

source test_ggshield_env/bin/active

Step 2: OK, now, let flow below content to start the installation ggshield

To install ggshield on Windows(CMD):

py -m pip install ggshield

To install ggshield on Unix/macOs:

pip install ggshield

Step 3: If you want to install a specific ggshield version, add ==<ggshield version> to the end command line

Example:

pip install ggshield==1.0.0

Please see the version list below table:

Version	Released date	Command
ggshield 1.13.0	2022-07-20T12:43:33	Windows: `py -m pip install ggshield==1.13.0` Unix/macOs: `pip install ggshield==1.13.0`
ggshield 1.12.0	2022-05-30T12:00:37	Windows: `py -m pip install ggshield==1.12.0` Unix/macOs: `pip install ggshield==1.12.0`
ggshield 1.11.0	2022-03-29T09:58:59	Windows: `py -m pip install ggshield==1.11.0` Unix/macOs: `pip install ggshield==1.11.0`
ggshield 1.10.8	2022-01-31T09:49:04	Windows: `py -m pip install ggshield==1.10.8` Unix/macOs: `pip install ggshield==1.10.8`
ggshield 1.10.7	2021-11-25T14:59:20	Windows: `py -m pip install ggshield==1.10.7` Unix/macOs: `pip install ggshield==1.10.7`
ggshield 1.10.6	2021-11-25T14:36:58	Windows: `py -m pip install ggshield==1.10.6` Unix/macOs: `pip install ggshield==1.10.6`
ggshield 1.10.5	2021-11-18T17:57:21	Windows: `py -m pip install ggshield==1.10.5` Unix/macOs: `pip install ggshield==1.10.5`
ggshield 1.10.4	2021-11-05T13:33:36	Windows: `py -m pip install ggshield==1.10.4` Unix/macOs: `pip install ggshield==1.10.4`
ggshield 1.10.3	2021-11-02T16:33:00	Windows: `py -m pip install ggshield==1.10.3` Unix/macOs: `pip install ggshield==1.10.3`
ggshield 1.10.2	2021-11-02T14:39:51	Windows: `py -m pip install ggshield==1.10.2` Unix/macOs: `pip install ggshield==1.10.2`
ggshield 1.10.1	2021-10-29T12:55:42	Windows: `py -m pip install ggshield==1.10.1` Unix/macOs: `pip install ggshield==1.10.1`
ggshield 1.10.0	2021-10-29T12:30:54	Windows: `py -m pip install ggshield==1.10.0` Unix/macOs: `pip install ggshield==1.10.0`
ggshield 1.9.0	2021-10-11T15:51:16	Windows: `py -m pip install ggshield==1.9.0` Unix/macOs: `pip install ggshield==1.9.0`
ggshield 1.8.2	2021-09-23T11:56:31	Windows: `py -m pip install ggshield==1.8.2` Unix/macOs: `pip install ggshield==1.8.2`
ggshield 1.8.1	2021-08-20T09:38:37	Windows: `py -m pip install ggshield==1.8.1` Unix/macOs: `pip install ggshield==1.8.1`
ggshield 1.8.0	2021-08-20T08:33:21	Windows: `py -m pip install ggshield==1.8.0` Unix/macOs: `pip install ggshield==1.8.0`
ggshield 1.7.3	2021-07-19T17:15:26	Windows: `py -m pip install ggshield==1.7.3` Unix/macOs: `pip install ggshield==1.7.3`
ggshield 1.7.2	2021-07-15T07:48:01	Windows: `py -m pip install ggshield==1.7.2` Unix/macOs: `pip install ggshield==1.7.2`
ggshield 1.7.1	2021-07-12T14:22:56	Windows: `py -m pip install ggshield==1.7.1` Unix/macOs: `pip install ggshield==1.7.1`
ggshield 1.7.0	2021-07-06T08:59:24	Windows: `py -m pip install ggshield==1.7.0` Unix/macOs: `pip install ggshield==1.7.0`
ggshield 1.6.1	2021-06-23T15:44:12	Windows: `py -m pip install ggshield==1.6.1` Unix/macOs: `pip install ggshield==1.6.1`
ggshield 1.6.0	2021-06-23T11:59:53	Windows: `py -m pip install ggshield==1.6.0` Unix/macOs: `pip install ggshield==1.6.0`
ggshield 1.5.0	2021-05-06T08:14:52	Windows: `py -m pip install ggshield==1.5.0` Unix/macOs: `pip install ggshield==1.5.0`
ggshield 1.4.0	2021-03-31T12:54:23	Windows: `py -m pip install ggshield==1.4.0` Unix/macOs: `pip install ggshield==1.4.0`
ggshield 1.3.2	2021-03-05T09:43:11	Windows: `py -m pip install ggshield==1.3.2` Unix/macOs: `pip install ggshield==1.3.2`
ggshield 1.3.1	2021-03-04T10:14:39	Windows: `py -m pip install ggshield==1.3.1` Unix/macOs: `pip install ggshield==1.3.1`
ggshield 1.3.0	2021-01-13T14:27:24	Windows: `py -m pip install ggshield==1.3.0` Unix/macOs: `pip install ggshield==1.3.0`
ggshield 1.2.3	2020-09-17T08:46:31	Windows: `py -m pip install ggshield==1.2.3` Unix/macOs: `pip install ggshield==1.2.3`
ggshield 1.2.2	2020-09-01T08:08:06	Windows: `py -m pip install ggshield==1.2.2` Unix/macOs: `pip install ggshield==1.2.2`
ggshield 1.2.0	2020-07-15T14:10:44	Windows: `py -m pip install ggshield==1.2.0` Unix/macOs: `pip install ggshield==1.2.0`
ggshield 1.1.0	2020-07-02T08:44:38	Windows: `py -m pip install ggshield==1.1.0` Unix/macOs: `pip install ggshield==1.1.0`
ggshield 1.0.3	2020-06-29T15:18:55	Windows: `py -m pip install ggshield==1.0.3` Unix/macOs: `pip install ggshield==1.0.3`
ggshield 1.0.2	2020-06-25T16:18:02	Windows: `py -m pip install ggshield==1.0.2` Unix/macOs: `pip install ggshield==1.0.2`
ggshield 1.0.1	2020-06-23T12:13:26	Windows: `py -m pip install ggshield==1.0.1` Unix/macOs: `pip install ggshield==1.0.1`
ggshield 1.0.0	2020-06-23T11:54:07	Windows: `py -m pip install ggshield==1.0.0` Unix/macOs: `pip install ggshield==1.0.0`

Step 4: Otherwise, you can install ggshield from local archives:

Download the distribution file from ggshield-1.13.0.tar.gz or the specific ggshield version in the below list of distribution

After that, install by command:

On Windows(CMD):

py -m pip install <path_to_ggshield_downloaded_file>

On Unix/macOs:

pip install <path_to_ggshield_downloaded_file>

List distribution:

Project link:

- Homepage

How to install ggshield via python pip

Installation:

Step 1: First, ensure you installed pip in your os, to check pip has been installed on your computer

Step 2: OK, now, let flow below content to start the installation ggshield

Step 3: If you want to install a specific ggshield version, add ==<ggshield version> to the end command line

Step 4: Otherwise, you can install ggshield from local archives:

Cookie Consent