commitPackage 0.1.2

A fun and lighthearted package for generating random and styled Git commit messages.

LazyCommit Package

Team Members

1. Jasmeen Kaur
2. Sophia Schlichting
3. Preston Lee
4. Julia Ahn

About LazyCommit

LazyCommit is a fun and lighthearted package for generating random and styled Git commit messages.

PyPI Package Link

Installation

pip install commitPackage

Development Guide

Clone the Respository

git clone [e-mail]:software-students-spring2025/3-python-package-pack-it-up.git
cd 3-python-package-pack-it-up

Setting up the environment variables

To ensure proper access to the database, you need a .env file. Run the following command in the root directory of the project to create a .env file:

touch .env
nano .env

Once the file opens in a text editor, set the required values as follow:

MONGO_DBNAME=lazyCommit
MONGO_URI=your_mongodb_connection_uri
DEBUG=True

Ensure the .env file is not committed by adding it to .gitignore:

echo ".env" >> .gitignore

For more details, check env.example.

Set up Virtual Environment

pip install pipenv
pipenv shell

Usage

Import the package and use the following functions:

from commitPackage.lazyCommit import (
    generate_commit_message, random_commit_message,
    git_blame_excuse, generate_haiku, add_commit_message, add_excuse, add_haiku
)

print(random_commit_message())
#Output: Random commit message from the database

print(generate_commit_message('funny'))
#Output: Random commit message with the specific style

print(git_blame_excuse())
#Output: Random excuse from database

print(generate_haiku())
#Output: Random haiku from the database

print(add_commit_message('funny', 'Example Program Commit Message'))
#Output: Add commit message to a style

print(add_excuse('Example Program Excuse'))
#Output: Add an excuse to the database

print(add_haiku('Breeze whispers through trees, Golden leaves dance on the wind, Autumn's soft embrace.'))
#Output: Add a haiku to the databse

Or try running the package as a script:

python -m commitPackage --random

python -m commitPackage --style funny
python -m commitPackage --style serious
python -m commitPackage --style professional
python -m commitPackage --style technical

python -m commitPackage --blame

python -m commitPackage --haiku

python -m commitPackage --addMessage funny "Fixed a typo"
python -m commitPackage --addMessage serious "Refactored database access layer"
python -m commitPackage --addMessage chaotic "DO NOT DELETE - I'm warning you"

python -m commitPackage --addExcuse "The intern wrote this line"

python -m commitPackage --addHaiku "Branches intertwine, Merge conflicts are poetry, Git writes our stories."

Running exampleProgram.py

To run exampleProgram.py, make sure you are in your virtual environment and have all dependencies installed. Then, run the following command:

python exampleProgram.py

Contribute

To contribute to this project follow these steps:

1. Follow the steps mentioned in the Development Guide to clone repository and set up the virtual environment
2. Create and switch to a new feature branch

git checkout -b feature-name.

3. Commit your changes

git add .
git commit -m "Added new feature"

4. Push to your branch

git push origin feature-name

5. Open a pull request through github to merge your branch to the main

Build and Publish Package

To build the package and upload it to TestPyPI:

python -m build
twine upload -r testpypi dist/*

To publish it to PyPI:

twine upload dist/*

Run Tests

Units test are provided in the tests directory. To run those use:

1. Install pytest into the virtual environment, e.g. pipenv install pytest
2. Run the following command from the main project directory:

python -m pytest 

or this if you have a python3:

python3 -m pytest 

Function Documentation

random_commit_message()

Generates a randomly selected commit message from the database

Parameters:

• None

Return:

• str: A randomly selected commit message

---

generate_commit_message(style)

Generates a randomly selected commit message that has the style the user specified

Parameters:

• style (str): the style of message the user wants

Return:

• str: A randomly selected commit message from the user's desired style

---

git_blame_excuse()

Generates a randomly selected excuse

Parameters:

• None

Return:

• str: A randomly selected excuse

---

generate_haiku()

Generates a randomly selected haiku

Parameters:

• None

Return:

• str: A randomly selected excuse

---

add_commit_message(style, message)

Allows a user to create a new commit message

Parameters:

• style (str): the style of message the user wants to add
• message (str): the message the user wants to add

Return:

• str: if the message was successfully saved to the database, a confirmation str will be displayed
• str: if the message already exists in the database, a str outlining that will be displayed
• str: if there are issues with saving the message, and error message will be displayed

---

add_excuse(message)

Allows a user to create a new excuse

Parameters:

• message (str): the excuse the user wants to add

Return:

• str: if the excuse was successfully saved to the database, a confirmation str will be displayed
• str: if the excuse already exists in the database a str outlining that will be displayed
• str: if there are issues with saving the excuse an error message will be displayed

---

add_haiku(message)

Allows a user to create a new haiku

Parameters:

• message (str): the haiku the user wants to add

Return:

• str: if the haiku was successfully saved to the database, a confirmation str will be displayed
• str: if the haiku already exists in the database, a message outlining that will be displayed
• str: if there are issues with saving the haiku an error message will be displayed## Deveopment Guide