Skip to content

Commit

Permalink
Update readme and ignore
Browse files Browse the repository at this point in the history
  • Loading branch information
marcvspt committed Aug 22, 2023
1 parent 59102f8 commit 7e3500f
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 3 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@
*.encrypted
*.signed
Pipfile.lock
.pytest_cache
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ In this repository we have a tool that use `python-gnupg`, **GPG Python Suite**

- [GPG Python Suite](#gpg-python-suite)
- [Install](#install)
- [CLI configuration](#cli-configuration)
- [VSCode configuration](#vscode-configuration)
- [Usage](#usage)
- [Generate keys](#generate-keys)
- [Encrypt messages](#encrypt-messages)
Expand All @@ -11,13 +13,29 @@ In this repository we have a tool that use `python-gnupg`, **GPG Python Suite**
- [Verify signatures](#verify-signatures)

## Install
First install `pipenv` or `python-pipenv`/`python3-pipenv` (depends how was named by your package manager). Install it with `pip`/`pip3` is possible, but in **2023**, **PyPi** recomends use your package manager to install libraries and packages.

```bash
git clone https://github.com/marcvspt/gpg-pysuite
cd gpg-pysuite
python3 -m pip install -r requeriments.txt
python3 gpg_pysuite.py -h
```

### CLI configuration
```bash
pipenv install
pipenv shell
```

### VSCode configuration
If you do the normal terminal instalation inside vscode terminal, you have to close and reopen the application or do this:
1. Open `Command Palette`. Linux and Windows: `Ctrl + Shift + P`. For MacOS: `Command + Shift + P`
2. Type `> clear cache and reload window`.

Now configure the python interpreter:
1. Open `Command Palette`. Linux and Windows: `Ctrl + Shift + P`. For MacOS: `Command + Shift + P`
2. Type `> python select interpreter`.
3. Select **PipEnv** option.

## Usage
```bash
$ python3 gpg_pysuite.py -h
Expand Down Expand Up @@ -53,6 +71,7 @@ options:

### Encrypt messages
The tool can encrypt the messages with the **public key** (Asymmetric) and **private key** (Symmetric).

```bash
$ python3 gpg_pysuite.py encrypt -h

Expand Down Expand Up @@ -107,6 +126,7 @@ options:

### Verify signatures
The tool can verify the signatures with the **public key**.

```bash
$ python3 gpg_pysuite.py verify -h

Expand All @@ -118,4 +138,4 @@ options:
Path to GPG public key
-m MESSAGE, --signed-message MESSAGE
Path to signed message
```
```

0 comments on commit 7e3500f

Please sign in to comment.