mkpassphrase 0.6.3

Word-based passphrase generator

============
mkpassphrase
============

.. image:: https://travis-ci.org/eukaryote/mkpassphrase.svg?branch=master
`mkpassphrase` is a commandline script (and associated package) for generating
passphrases by concatenating words chosen from a dictionary file that
contains one word per line. It generates passwords like
`flippant Attests Ivory mildly` by default and is highly configurable.

Installation
------------

To install or upgrade to the latest stable version of `mkpassphrase` from PyPI,
you can install it as your normal user by running::

pip install --user --upgrade mkpassphrase

On Linux, that installs `mkpasphrase` to `~/.local/bin`, which you may need to
add to your `$PATH`.

Or you can install it globally by running::

sudo pip install --upgrade mkpassphrase


Usage
-----

Generate a passphrase using the default settings::

$ mkpassphrase
brusque Autumn advise Oratory
60,298 unique candidate words
1.32181e+19 possible passphrases

Options
-------

Use the `--help` option to see the available options::

$ mkpassphrase --help
usage: main.py [-h] [-n NUM_WORDS] [--min MIN] [--max MAX] [-f WORD_FILE]
[--lowercase] [--non-ascii] [-p PAD] [-d DELIM] [-V]

Generate a passphrase.

optional arguments:
-h, --help show this help message and exit
-n NUM_WORDS, --num-words NUM_WORDS
Number of words in passphrase
--min MIN Minimum word length
--max MAX Maximum word length
-f WORD_FILE, --word-file WORD_FILE
Word file path (one word per line)
--lowercase Make each word entirely lowercase, rather than the
default behavior of choosing Titlecase or lowercase
for each word (with probability 0.5)
--non-ascii Whether to allow words with non-ascii letters
-p PAD, --pad PAD Pad passphrase using PAD as prefix and suffix
-d DELIM, --delimiter DELIM
Use DELIM to separate words in passphrase
-V, --version Show version


Supported Python Versions and Operating Systems
-----------------------------------------------

mkpassphrase is tested under py27, py32, py33, py34, pypy, and pypy3 on Linux,
but should work on any OS that supports those Python versions.


=======
Changes
=======

v0.6.2
------

* added -q option to omit extra information about how many unique candidate
words were found and how many passphrases were possible
* fix for --ascii option not being used, and improved encoding handling
* start documenting changes in CHANGES.rst
* use README and CHANGES as long_description for improved pypi info