excuse-generator 1.0.2

A fun excuse generator for software engineers.

Excuse Generator for Software Engineers

excuse-generator is a fun and practical Python package that helps software engineers come up with excuses for common coding problems. Whether you're dealing with bugs, missed deadlines, PR delays, failed deployments, or awkward meetings, this package has you covered!

Table of Contents

• Installation
• Usage
• Functions
• Contributing
• License
• Authors

Installation

With pipenv:

1. Install pipenv if you don't have it yet:

pip install pipenv

2. Install the package and dependencies:

pipenv install --dev
pipenv shell

Or with pip:

1. Install the package:

pip install excuse-gnerator

Lastly, Start the code with:

pipenv run python -m excuse_generator

Usage

You can import the excuse_genertator module and start generating excuses! Here are a few examples of how to use the package:

from excuse_generator.excuses import generate_excuse, add_custom_excuse, random_excuse, list_categories

# Get a random excuse
print(random_excuse())

# Get an excuse for a specific category (e.g., bug, deadline)
print(generate_excuse("bug"))

# Add a custom excuse to a category
add_custom_excuse("bug", "It's a feature, not a bug.")
print(generate_excuse("bug"))

# List all available categories
print(list_categories())

Example Output

It works on my machine.
The timeline was more of a suggestion.
It's a feature, not a bug.
['bug', 'deadline', 'PR', 'meeting', 'deployment']

Functions

1. generate_excuse(category: str, resp_type: str = None) -> str
   - Generates a random excuse based on the specified category.
   - Categories: "bug", "deadline", "PR", "meeting", "deployment", "meeting_resp"
   - Some categories (like "meeting_resp") have subcategories.
   - Example: generate_excuse("bug")
   - Example: generate_excuse("meeting_resp", "technical")

2. random_excuse() -> str
   - Returns a random excuse from any category.

3. add_custom_excuse(category: str, excuse: str, resp_type: str = None)
   - Adds a new excuse to an existing category.
   - If the category has subcategories, specify resp_type.
   - Example: add_custom_excuse("meeting_resp", "Dog unplugged my router.", "technical")

4. list_categories() -> list
   - Returns a list of available excuse categories and subcategories.

5. help()
   - Displays functions

Authors

• Andrew Jung (AndrewJung03)
• Juno Cheung (avacheungx)
• Ray Huang (RayHuang3339)
• • Krish Kothari (krish-nyu)