README.mkd

   1 A simple command line script that generates XKCD-style multiword passwords/passphrases.
   2 Inspired by http://xkcd.com/936/
   3
   4
   5 ![XKCD password strength](http://imgs.xkcd.com/comics/password_strength.png)
   6
   7 For more memorable words, try `2of12.txt` or `3esl.txt` (both included here for convenience), available from http://wordlist.sourceforge.net/
   8
   9 A simple example of how the script may be used via `import` is also provided.
  10
  11 **Requirements:** Python 2.4+ (Python 3 compatible)
  12
  13 **Usage:**
  14 xkcd-password.py [options]
  15
  16 * `-w WORDFILE, --wordfile=WORDFILE` List of valid words for password
  17
  18 * `--min=MIN_LENGTH` Minimum length of words to make password
  19
  20 * `--max=MAX_LENGTH` Maximum length of words to make password
  21
  22 * `-n NUMWORDS, --numwords=NUMWORDS` Number of words to make password
  23
  24 * `-i, --interactive` Interactively select a password
  25
  26 * `-v VALID_CHARS, --valid_chars=VALID_CHARS` Valid chars, using regexp style (e.g. '[a-z]')
  27
  28 * `-V, --verbose` Report various metrics for given options
  29
  30 * `-a ACROSTIC, --acrostic=ACROSTIC` Constrain word choices to those starting with the letters in a given word
  31
  32 * `-c COUNT, --count=COUNT` Number of passwords to generate
  33
  34 * `-d DELIMITER, --delimiter=DELIMITER` separator character between words
  35
  36
  37 Licensed under the BSD license.