BetterPassphrase

BetterPassphrase is a Python library and CLI tool for generating somewhat secure, meaningful passphrases. It uses various parts of speech to construct grammatically correct and easy-to-remember phrases.

Features

• Customizable Length: Generate passphrases with a specified number of words.
• Custom Separators: Use any character as a separator between words.
• Capitalization Options: Choose whether to capitalize the words in the passphrase.
• Probability Calculation: Get the uniqueness probability of the generated passphrase.
• Verbose Output: Optionally display detailed information about the generation process.
• CLI Support: Generate passphrases directly from the command line.
• Multiple Phrases: Generate multiple passphrases at once.
• Output to File: Save generated passphrases to a file.

Installation

Install the package via PyPI:

pip install BetterPassphrase

Usage

Library Usage

Use the library in your Python code to generate passphrases programmatically:

from betterpassphrase import generate_phrase

# Generate a passphrase
phrase = generate_phrase(length=6, sep="-", capitalize=True)

print(f"Generated passphrase: {phrase.passphrase}")
print(f"Word count: {phrase.word_count}")
print(f"Probability: {1 / phrase.one_of:.2e}")

CLI Usage

After installing the package, you can use the betterpassphrase command directly from your terminal:

betterpassphrase --length 6 --sep "" --capitalize --verbosity 1

Options

Example CLI Output

$ betterpassphrase --length 8 --sep "-"
Generated phrase: the-actor-and-the-subtle-dancer-played-wonderfully
Word count:       8

To generate a passphrase with capitalization and a custom separator:

$ betterpassphrase --length 8 --sep "=" --capitalize
Generated phrase: The=Actor=And=The=Subtle=Dancer=Played=Wonderfully
Word count:       8

To generate multiple passphrases:

$ betterpassphrase --length 4 --num-phrases 3
Generated phrase: curious-monkey-jumped-over
Generated phrase: silent-shadow-walked-alone
Generated phrase: sloppy-photographer-developed-timer

To write the passphrase(s) to a file:

$ betterpassphrase --length 8 --sep "-" --output passphrase.txt
Generated phrase: the-actor-and-the-subtle-dancer-played-wonderfully

$ cat passphrase.txt
the-actor-and-the-subtle-dancer-played-wonderfully

Verbose mode can provide additional details:

$ betterpassphrase --length 6 --verbosity 2
Generated phrase:       what-dirty-photographer-wrapped-which-stethoscope
Word count:             6
Wordlist Probability:   3.64e-14
Character Probability:  5.51e-63
Parts of speech:        determiner, adjective, subject_noun, verb, determiner, object_noun

Development

Setting Up for Local Development

1. Clone the repository:

   git clone https://github.com/yourusername/BetterPassphrase.git
   cd BetterPassphrase
   

2. Install the package locally in editable mode:

   pip install -e .
   

3. Run tests:

   pytest
   

Contributing

Contributions are welcome! If you have ideas for improvements or new features, feel free to open an issue or submit a pull request.

1. Fork the repository.
2. Create a feature branch.
3. Commit your changes.
4. Submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Author

Subhayu Kumar Bala

Acknowledgments

• Inspired by the concept of secure passphrases for authentication.
• Built with Python's secrets and random libraries for randomness and security.