Skip to content

Commit

Permalink
fix: 🐛 generate command help
Browse files Browse the repository at this point in the history
  • Loading branch information
ZhaoQi99 committed Nov 24, 2021
1 parent cb73814 commit 6273274
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,20 @@ pip install git+https://github.com/ZhaoQi99/pyencrypt-pye.git
✨🍰✨
```
## Usage

```shell
Usage: pyencrypt [OPTIONS] COMMAND [ARGS]...

Options:
--version Show the version and exit.
-h, --help Show this message and exit.

Commands:
decrypt Decrypt encrypted pye file
encrypt Encrypt your python code
generate Generate loader file using specified key
```

### Encrypt
```shell
~$ pyencrypt encrypt -h
Expand All @@ -46,6 +60,19 @@ Options:
-k, --key TEXT Your encryption key. [required]
-h, --help Show this message and exit.
```
### Generate

```shell
~$ pyencrypt generate -h
Usage: pyencrypt generate [OPTIONS]

Generate loader file using specified key

Options:
-k, --key TEXT Your encryption key. [required]
-h, --help Show this message and exit.
```

## Example
### Encrypt
```shell
Expand Down
3 changes: 3 additions & 0 deletions pyencrypt/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@
from pyencrypt.encrypt import (can_encrypt, encrypt_file, encrypt_key,
generate_so_file)
from pyencrypt.generate import generate_aes_key
from pyencrypt.check import CheckFinder


VERSION = f"""\
_
Expand Down Expand Up @@ -153,6 +155,7 @@ def decrypt_command(pathname, key):
required=True,
help='Your encryption key.',
type=click.STRING)
@click.help_option('-h', '--help')
@click.pass_context
def generate_loader(ctx, key):
"""Generate loader file using specified key"""
Expand Down

0 comments on commit 6273274

Please sign in to comment.