Metadata-Version: 2.0
Name: makepass
Version: 0.9.6
Summary: A simple password generator based on https://xkcd.com/936/
Home-page: https://github.com/Lucretiel/MakePass
Author: Nathan West
Author-email: UNKNOWN
License: GPLv2
Platform: any
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Utilities
Requires-Dist: autocommand (<3.0.0,>=2.1.0)

MakePass
========

A password generator inspired by https://xkcd.com/936/

Usage
-----

Simply install the package with ``pip install makepass``, then run the ``make_pass`` command::

    $ make_pass
    CorrectHorseBatteryStaple7

The password is written to stdout, from which it can be captured via your pipelined capture mechanism of choice.

Process & Constraints
---------------------

Makepass generates a memorable, readable password by combining **N** unique, random common english words, which are sourced from the `Google Common English Words <https://github.com/first20hours/google-10000-english>`_ repository. By default, the list of 20,000 english words is used. The set of words is constrained to words between **m** and **n** characters long, inclusive, to promote memorability and prevent common words. A random numeral is appended, to satisfy the common requirement that passwords contain a letter and a number. The final password will be between **L** and **M** characters long; up to **S** passwords are generated internally until a password of appropriate length is found.

All of the above can be configured; run ``make_pass -h`` for a list of the flags that modify its behavior, as well as options for display of entropy information

Defaults.
~~~~~~~~~

All of the following parameters can be changed:

- **N** = 4
- **m** = 4
- **n** = 8
- **L** = 24
- **M** = ∞
- **S** = 10,000
- Random numeral **is** appended
- Word set: 20k. Can be repaced with the 10k set.

These default parameters produce passwords with an entropy of approximately 57.561 bits.


