passgenpyNYU 1.1.0

Generating serious and funny passwords.

Password Generator

Our python package provides various password generation and manipulation functions, including a fun password generator that creates hilarious word combinations.

Pypi Website: Link

Installation

To install the package:

pip install passgenpyNYU==1.1.0

To install the package into your virutal environment:

pipenv install passgenpyNYU==1.1.0

To activate your virtual environment:

pipenv shell

To exit your virtual environment:

exit

To run the package from the terminal:

passgenpyNYU -g 10

The above calls the generate function to generate a random password of length 10. Use "python3 -m passgenpyNYU -h" to see all available terminal commands.

Features / Running the package in your own code

The package provides several functions for password generation and manipulation:

1. generate(length)

Generates a random password with specified characteristics.

Parameters:

• length (int): The desired length of the password

Example:

from passgenpyNYU import core as cd

# Generate a simple 8-character password
password = cd.generate(8)

2. caesar_cipher(word, shift)

Applies a Caesar cipher to the input string.

Parameters:

• word (str): The text to encrypt
• shift (int): The shift value (must be between 1 and 25)

Example:

from passgenpyNYU import core as cd

encrypted = cd.caesar_cipher("Hello", 3)

3. scramble(string)

Randomly scrambles the characters in the input string.

Parameters:

• string (str): The text to scramble

Example:

from passgenpyNYU import core as cd

scrambled = cd.scramble("Hello World")

4. binary_password(length)

Generates a random binary password of specified length.

Parameters:

• length (int): The desired length of the binary password

Example:

from passgenpyNYU import core as cd

binary = cd.binary_password(8)

5. generateHash(password)

Generates a SHA-256 hash of the input password.

Parameters:

• password (str): The password to hash

Example:

from passgenpyNYU import core as cd

hashed = cd.generateHash("myPassword123")

6. getFunnyPassword()

Generates a funny password by combining random words from predefined lists.

Example:

from passgenpyNYU import core as cd

funny_pass = cd.getFunnyPassword()

Link to Example code: example.py

How to Contribute:

Clone the git repository into your local repository using the following command:

git clone https://github.com/software-students-spring2025/3-python-package-ejsm.git

To execute any of the following steps, first navigate to the project directory:

cd [path to project directory]

To set up the virtual environment, you must first download pipenv:

pip install pipenv

Next, use the following command to activate the virtual environment:

pipenv shell

If you want to install dependencies into your virtual environment:

pipenv install [name of package]

To build the package, you must first activate the virtual environment and then build:

pipenv shell
python3 -m build

To test the package, you must first activate the virtual environment and then test using pytest:

pipenv shell
python3 -m pytest

There are already 27 different tests cases that can found in tests/test_core.py.

To make contributes, you must first create a new branch, switch to that branch, commit that branch to the git repository and make a Pull Request on git:

git branch [branch name]
git checkout [branch name]
git add [file]
git commit -m "commit message"
git push origin [branch name]

Contributors:

Jeffrey Chen - Github Link

Shaurya Srivastava - Github Link

Ethan Zheng - Github Link

Max Meyring - Github Link