Ascii-Art-TNH 1.1.4

A small silly package which prints ASCII art based on certain inputs. Watch out for the interrupting cow

Python Package Exercise: ASCII ZOO

Project Description

ASCII ZOO is a small silly python package that prints ASCII animal art based on certain user inputs. Watch out for the interrupting cow... (It appears randomly).

ASCII Zoo allows you to:

1. Print Art Animal: Displays ASCII art of the animal along with its name.
2. Animal Sounds: Outputs the corresponding sound after printing the ASCII animal.
3. Surprise Cow: Randomly shows up with an ASCII art representation and a “moo”.
4. Wrong Output: Handles unrecognized animal names, confirming wrong input with a playful response.

Example Code

from ascii_art_TNH import ascii_art

ascii_art("cat dog") # Will print one cat and one dog

ascii_art("cow") # Will print one cow

How this package was created

.
├── .github
│   └── workflows
│       ├── test_one.yaml
│       ├── test_two.yaml
│       ├── test_three.yaml
│       └── test_four.yaml
├── src
│   └── ascii_art_TNH
│       ├── __init__.py
│       ├── __main__.py
│       ├── ascii_art.py
│       ├── gallery.py
│       └── noises.py
├── tests
│   ├── __init__.py
│   ├── input_parse_test.py
│   ├── moo_test.py
│   ├── wrong_input_test.py
│   └── get_noise_test.py
├── .gitignore
├── README.md
├── pyproject.toml
└── requirements.txt

How to install and use this package

Prerequisites

• Python (version 3.6 or later)
• pip (Python package installer)
• pipenv (for managing virtual environments)

Installation

You can find our package on PyPI: Ascii_Art_TNH

To install the package, use pip:

pip install Ascii_Art_TNH

How to run unit tests

Test are included within the 'test' directory. To run these test...

1. Install pytest in a virtual enviorment
2. Run the test from the main project directory:

python3 -m pytest

How to contribute

Clone the repository

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

Set up the virtual environment and install any dependencies

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

Build and test the package

python -m build
python -m pytest

Continuous integration

This project uses a continuous integration workflow that builds and runs unit tests automatically with every push of the code to GitHub.

Team Members

Hugo
Nuzhat
Melanie
Tamara