pyAnimals-ejh 0.1.1

A fun package that displays animals on the terminal with movement and messages.

pyAnimals-ejh

Table of Contents

1. Description
2. PyPI Page
3. Installation
4. Virtual Environment & Dependencies
5. Running pyAnimals_ejh
6. Examples
7. Contributing
8. Team Members

Description

A fun package that displays animals on the terminal with movement and messages.

PyPI Page

You can find pyAnimals_ejh on PyPI HERE

Installation

Install pyAnimals_ejh with pip:

pip install pyAnimals_ejh

Virtual Environment & Dependencies

Set up the virtual environment:

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Running pyAnimals_ejh

To run pyAnimals_ejh, use the following command:

python -m pyAnimals_ejh

Examples

Parameter for all functions are: animal (str): name of animal.
***Note: Valid animal names include "cat", "bunny", "elephant", "rabbit". Only these can be used with our package.

1. move(animal) Moves specified animal across the terminal screen

move("cat")

2. race(animal) Displays race between player and specified animal

race("rabbit")

3. randMessage(animal) Prints a random message for the specified animal

randMessage("bunny")

4. print_fact(animal) Prints a random fact for the specified animal. Raises: ValueError if no facts are available for the specified animal.

print_fact("elephant")

See an example program that uses all functions HERE

Contributing

We welcome contributions to enhance and grow pyAnimals_ejh! Follow these steps to set up the development environment:

1. Clone the Repository:

git clone https://github.com/software-students-fall2024/3-python-package-ejh.git
cd 3-python-package-ejh

2. Set Up the Virtual Environment

source venv/bin/activate
pip install -r requirements.txt

3. Build and Test the Package

python -m build

4. Run Tests

pytest

5. Add New Tests
   If you add new functionality, include tests in the tests directory.

Team members

Haley Hobbs
Emma Zhu
Jason Tran
Jenna Han