Metadata-Version: 2.1
Name: python-ninethreesix
Version: 0.2.1
Summary: A password generator based on xkcd.com/936
Author-email: Brad Montgomery <brad@bradmontgomery.nte>
License: MIT
Project-URL: Homepage, https://github.com/bradmontgomery/python-ninethreesix
Project-URL: Bug Tracker, https://github.com/bradmontgomery/python-ninethreesix/issues
Keywords: password,utility
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Security
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# ninethreesix

[![version](http://img.shields.io/pypi/v/python-ninethreesix.svg?style=flat-square)](https://pypi.python.org/pypi/python-ninethreesix/) [![license](http://img.shields.io/pypi/l/python-ninethreesix.svg?style=flat-square)](https://pypi.python.org/pypi/python-ninethreesix/) [![made-with-python](https://img.shields.io/badge/Made%20with-Python-1f425f.svg?style=flat-square)](https://www.python.org/) [![PyPI download month](https://img.shields.io/pypi/dm/python-ninethreesix.svg?style=flat-square)](https://pypi.org/project/python-ninethreesix/)

**a password generator**


## usage

From python::

    >>> from ninethreesix import Password
    >>> p = Password(num_words=3, min_len=3, max_len=6)
    >>> p.as_string()
    'whelp-word-out'

Or run the module directly::

    $ python -m ninethreesix.password

    show-sine-Troy

## what's with the name?

See: [http://xckd.com/936/](http://xckd.com/936/)


## license

The code here is available under the MIT license.


## word list

The bundled word list comes from the Moby Word list by Grady Ward, which is
listed in the public domain.

The bundled word file is COMMON.TXT, which is:

    74,550 common dictionary words (common.txt)
    A list of words in common with two or more published dictionaries.
    This gives the developer of a custom spelling checker a good
    beginning pool of relatively common words.

For the original sources, see:
[http://www.gutenberg.org/ebooks/3201](http://www.gutenberg.org/ebooks/3201).


## Development

If you want to work on this library, see the development requirements in `requirements.in` 
and install them with `pip install -r requirements.txt`.  The latter is managed by `pip-tools` and can be updated by running `pip-compile`.

Bug  fixes and new features can be proposed by opening a Pull Request for this repo.

### Tests

Run the test suite with `pytest --cov`
