Quickstart

papass

PyPI Documentation Status CI

This is a work in progress

papass generates passphrases following the diceware approach as proposed by Arnold G. Reinhold.

Quickstart#

Assuming you have a wordlist file wordlist.txt you can run the following command to generate a random list of four words:

$ papass -c 4 -w wordlist.txt
Phrase: grimy street acetone overcast
Entropy: 51.6993

By default this uses the system’s most secure random number generator. To use physical dice add -r dice. See papass.readthedocs.io for the full documentation.

Development#

Create a virtual environment (e.g. via python -m venv or mamba/micromamba). Install (development) dependencies and papass in editable mode:

$ pip install -r requirements.txt -e .

Run unit tests via

$ pytest

Formatting and linting is done via ruff.

$ ruff format
$ ruff check --fix

To build the docs install e.g. make and do

$ pip install -r docs/requirements.txt
$ make -C docs/ html