pybirthday 0.1.1

A Python package that lets users generate festive birthday-themed visuals.

The pybirthday Package

pybirthday is a Python package that lets users generate festive birthday-themed visuals!
insert PyPI link here
Currently, the package offers four functions:

1. cake(): returns a birthday cake with a personalized name and a custom message.
   • Syntax: pybirthday.cake(name, words)
   • Parameters:
     • name (optional): A string (up to 15 characters) to be displayed on the cake. If no name is provided or invalid, the cake will display a blank space.
     • words (optional): A string with a custom message to be printed below the cake. Defaults to "Hope all your birthday wishes come true!"
2. candle(): returns an image of a candle from various styles.
   • Syntax: pybirthday.candle(style)
   • Parameter:
     • style: Optional. Values of 0-4 each specify a candle style. If out of range, style #4 is returned. Defaults to random.
3. balloon(): returns an image of birthday balloons from various styles.
   • Syntax: pybirthday.balloon(style)
   • Parameter:
     • style: Optional. Specifies a balloon style. Defaults to random.
4. teddy(): returns a cute teddy bear bringing you a birthday greeting!
   • Syntax: pybirthday.teddy(age, name)
   • Parameters:
     • age: Optional. Includes age in the greeting. Specify in oridinal format (i.e "20th, "2nd"). Can take integers or strings of no more than 10 characters.
     • name: Optional. Includes name in the greeting. Can take strings of no more than 10 characters.
     • Invalid parameters are ignored!

Installation

Install the package via pip:

pip install pybirthday

Usage

from pybirthday import cake, candle, balloon, teddy

mycake = cake("Alice", "Happy 20th Birthday!")
print(mycake) #prints cake with "Alice" written on cake, and "Happy 20th Birthday!" at the bottom

myteddy = teddy("20th", "Bob")
print(myteddy) #prints teddy bear saying "HAPPY 20TH BIRTHDAY BOB"

mycandle_1 = candle()
mycandle_2 = candle(2)
print(mycandle_1) #prints a random candle
print(mycandle_2) #prints candle style #3

myballoon_1 = balloon()
myballoon_2 = balloon(2)
print(myballoon_1) #prints random balloons
print(myballoon_2) #prints balloon style #3

How to contribute to this project

1. Fork this repository and then clone it to your local machine:

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

2. Set up a virtual environment

   python -m venv venv
   source venv/bin/activate  # On macOS/Linux
   venv\Scripts\activate  # On Windows
   

3. Build the package

   pip install build
   python -m build
   

Testing

Unit tests are included within the tests directory. To run these tests:

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

   python -m pytest
   

Team

• Eric Xu
• Frank Fang
• Lauren Zhou
• Shuyuan Yang