Python Roast Package

Description

• Our project is a Python package that generates light-hearted 'roasts', insults, directed to the user. The package contains different types of roast that the user can pick and generate.

Link to package

• This is the Link to our group's package page: pyroasts

How to install and use this package

1. Create a pipenv-managed virtual environment and install the latest version of our package installed: pipenv install pyroasts.
2. Activate the virtual environment: pipenv shell.
3. Create a Python program file that imports your package and uses it, e.g. from pyroasts import * and then print(get_roast()) (replace get_roast()with any function that exists in our package) .
4. Run the program: python3 my_program_filename.py.
5. Exit the virtual environment: exit.

Here are some coding examples:

How to set up the virtual environment, install dependencies, and build and test our package

1. If you haven't already, install pipenv using the command: pip install pipenv
2. Install all the dependencies listed in the Pipfile: pipenv install
3. Activate the virtual environment: pipenv shell.
4. Run all the tests: pytest or python3 -m pytest.
5. Exit the virtual environment

Teammates

Links to all the member's Github accounts:

• https://github.com/ianpompliano
• https://github.com/sanskritig08
• https://github.com/ocnwaokoro
• https://github.com/mtodorovic27