Welcome to Niceware for Python’s documentation!

Contents:

Niceware for Python

PyPI status Build status Documentation Status Updates

A Python port of Niceware, for generating random-yet-memorable passwords. Each word provides 16 bits of entropy, so a useful password requires at least 3 words.

Because the wordlist is of exactly size 2^16, Niceware is also useful for converting cryptographic keys and other sequences of random bytes into human-readable phrases. With Niceware, a 128-bit key is equivalent to an 8-word phrase.

Usage

To insall

$ pip install niceware

To generate an 8-byte passphrase

>>> import niceware
>>> niceware.generate_passphrase(8)
['deathtrap', 'stegosaur', 'nilled', 'nonscheduled']

Niceware for Python uses os.urandom for entropy.

Credits

Niceware for Python is a port of Niceware, by yan.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install Niceware for Python, run this command in your terminal:

$ pip install niceware

This is the preferred method to install Niceware for Python, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for Niceware for Python can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/moreati/python-niceware

Or download the tarball:

$ curl  -OL https://github.com/moreati/python-niceware/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

To use Niceware for Python in a project:

import niceware

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/moreati/python-niceware/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

Niceware for Python could always use more documentation, whether as part of the official Niceware for Python docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/moreati/python-niceware/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up python-niceware for local development.

  1. Fork the python-niceware repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/python-niceware.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv python-niceware
$ cd python-niceware/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 niceware tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.7, 3.3, 3.4, 3.5, and 3.6. Check https://travis-ci.org/moreati/python-niceware/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ py.test tests.test_niceware

Indices and tables