Skip to content

Commit aa30ec3

Browse files
committed
Release Version 1.0.7.
1 parent a140d93 commit aa30ec3

File tree

2 files changed

+14
-12
lines changed

2 files changed

+14
-12
lines changed

README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
# xkcd_pass
1+
# xkcd-pass
22
![build status](https://github.com/adambirds/xkcd_password-gen/actions/workflows/build.yml/badge.svg)
3-
[![PyPI version](https://badge.fury.io/py/xkcd_pass.svg)](https://badge.fury.io/py/xkcd_pass)
3+
[![PyPI version](https://badge.fury.io/py/xkcd-pass.svg)](https://badge.fury.io/py/xkcd_pass)
44
[![codecov](https://codecov.io/gh/adambirds/xkcd_password-gen/branch/master/graph/badge.svg?token=4RKK2ABREH)](https://codecov.io/gh/adambirds/xkcd_password-gen)
5-
![PyPI - Downloads](https://img.shields.io/pypi/dm/xkcd_pass)
5+
![PyPI - Downloads](https://img.shields.io/pypi/dm/xkcd-pass)
66

77
A flexible and scriptable password generator which generates strong passphrases, inspired by XKCD 936
88

99
```
10-
$ xkcd_pass
10+
$ xkcd-pass
1111
> HeadscarfSuddenDumping93
1212
```
1313

1414
![](https://imgs.xkcd.com/comics/password_strength.png)
1515

1616
## Install
17-
`xkcd_pass` can easily be installed with the following command:
17+
`xkcd-pass` can easily be installed with the following command:
1818

1919
```
20-
pip install xkcd_pass
20+
pip install xkcd-pass
2121
```
2222

2323
or manually by:
@@ -35,17 +35,17 @@ Contributions welcome and gratefully appreciated!
3535
Python 3 (Version 3.6 or later).
3636

3737
## Running `xkcd_pass`
38-
`xkcd_pass` can be called with no arguments with an output using the default wordfile and settings.
38+
`xkcd-pass` can be called with no arguments with an output using the default wordfile and settings.
3939
```
40-
$ xkcd_pass
40+
$ xkcd-pass
4141
> HeadscarfSuddenDumping93
4242
```
4343
The default settings return a single password made up of 3 words each having its first letter capitalized with two random digits afterwards.
4444

4545
It can also be called with a mixture of multiple arguments for example:
4646

4747
```
48-
$ xkcd_pass -d _ -c 5 --min 5 --max 7 --padding-digits-num 4
48+
$ xkcd-pass -d _ -c 5 --min 5 --max 7 --padding-digits-num 4
4949
> Mundane_Music_Spleen1837
5050
> Reuse_Acclaim_Clarify2492
5151
> Wildly_Contest_Anchor1798
@@ -62,14 +62,14 @@ This will return:
6262
A full overview of the available options can be accessed by running following command:
6363

6464
```
65-
xkcd_pass --help
65+
xkcd-pass --help
6666
```
6767

6868
## Word Lists
6969

7070
Several word lists are provided with the package. The default, eff-long, was specifically designed by the EFF for [passphrase generation](https://www.eff.org/deeplinks/2016/07/new-wordlists-random-passphrases) and is licensed under [CC BY 3.0](https://creativecommons.org/licenses/by/3.0/us/). As it was originally intended for use with Diceware ensure that the number of words in your passphrase is at least six when using it. Two shorter variants of that list, eff-short and eff-special, are also included. Please refer to the EFF documentation linked above for more information.
7171

72-
Note that `xkcd_pass` can be used with any word file of the correct format: a file containing one word per line.
72+
Note that `xkcd-pass` can be used with any word file of the correct format: a file containing one word per line.
7373

7474
## Changelog
7575

@@ -86,6 +86,8 @@ Note that `xkcd_pass` can be used with any word file of the correct format: a fi
8686
* Fix typo in static import causing wordfile error.
8787
* **Version 1.0.6**
8888
* Change package name to `xkcd_pass`.
89+
* **Version 1.0.7**
90+
* Change command-line package to `xkcd-pass`.
8991

9092
## License
9193

setup.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setuptools.setup(
77
name="xkcd-pass",
8-
version="1.0.6",
8+
version="1.0.7",
99
author="Adam Birds",
1010
author_email="adam.birds@adbwebdesigns.co.uk",
1111
description="Generate secure multiword passwords/passphrases, inspired by XKCD",

0 commit comments

Comments
 (0)