animalsay-jubilee 0.1.4

A fun package that makes animals say things with moods in ASCII art!

Python Package Exercise

An exercise to create a Python package, build it, test it, distribute it, and use it. See instructions for details.

Animal Say

Animal Say is a Python package that lets animals "speak" in ASCII art with different moods! You can have a cow, dog, cat, or sheep say anything you want, in a happy, sad, neutral, angry, or surprised mood.

USAGE:

import animalsay

# Make a happy dog say "Hello! I'm a happy dog!"
print(animalsay.dog("Hello! I'm a happy dog!", mood="happy"))

EXAMPLE OUTPUT:

Hello! I'm a happy dog!
      \
       \   / \__
          (    ∩\\__
          /         O
         /   (_____/
        /_____/   U

Available Animals

• cow
• dog
• cat
• sheep

Available Moods

• happy
• sad
• neutral
• angry
• surprised

Functions

All animals use the same function signature:

animal(test: str, mood: str = "neutral") -> str

• text: The string message the animal will "say".
• mood: One of the available moods (happy, sad, neutral, angry, surprised). Defaults to "neutral".
• Returns: A string containing the ASCII art of the animal speaking the message with the selected mood.

Example:

import animalsay

ascii_art = animalsay.sheep("Baa! I'm surprised!", mood="surprised")
print(ascii_art)

Contributions

To set up the project locally:

1. First, clone the repository into a workspace.

git clone https://github.com/user/repository-name.git
cd repository-name

2. Change this line in Pipfile into your current Python version.

[requires]
python_version = "3.10"

3. Then, use pipenv to install all dependencies.

pip install pipenv

pipenv install --dev

4. To build, run tests, or upload through twine, use pipenv to run our scripts.

pipenv run test # run tests
pipenv run build # build the package
pipenv run upload # upload to PyPI

Installation

1. Option A — Install from TestPyPI

   If the package has been uploaded to TestPyPI, install it using:

pip install -i https://test.pypi.org/simple/ animalsay-jubilee-yl9778

Tip: Add --upgrade if you already installed an older version.

pip install -i https://test.pypi.org/simple/ animalsay-jubilee-yl9778 --upgrade

2. Option B — Install from Source

   If you have cloned the repository manually:

git clone https://github.com/swe-students-fall2025/3-python-package-team_jubilee.git
cd 3-python-package-team_jubilee
pip install .

3. Option C - Install from real PyPI

pip install animalsay-jubilee

https://pypi.org/project/animalsay-jubilee/

Team Members

• Jasmine Zhu
• Grace He
• Vaishnavi Suresh
• Chengqi Li
• Krystal Lin

Have fun making animals talk! 🐶🐱🐮🐑