Python Mood Enhancer (pyMood)

Description

pyMood is a python package designed to give a quick mood boost to programmers. With simple commands, users can get positive affirmations, quick jokes, or even a virtual high five among other things. It's perfect for when you need a quick pick-me-up during a coding session.

Instructions

For any developers who want to import pyMood into their own code, follow the steps below:

To install the module from PyPI, run the command:

pip install pyMood==0.2

Then to use it, you can import using:

import pyMood.mood as mood

or

from pyMood import mood

Contributions

A virtual environment is required to build and test. First, clone the repository on your machine. To start the virtual environment, first you must install pipenv, activate edit mode and then activate the virtual environment:
pip install pipenv
pipenv install -e .
pipenv shell

Then install pyMood in your virtual environment from the remote version: pipenv install -i https://pypi.org/project/pyMood/0.2/

To install the dependencies of pyMood: pipenv install pytest build twine

To run the main file and our project: python3 -m pyMood

To run the unit tests provided you can then simply run: pytest

Then you can upload your changes to TestPyPI.

Usage

We have several functions to use from within pyMood.

relaxation_tip(category)
# Returns a random relaxation tip from a specified category to help the user relax.
# If no category is specified, return a random tip.

tell_me_a_joke()
# Returns a random joke to lighten up the user's mood

get_affirmation()
# Returns a random positive affirmation to boost the user's mood and confidence

coffee_suggestion()
# Returns a random cup of coffee as a suggestion, to help motivate the user.

cat_mood_generator()
# Returns a random cat emotion.

high_five()
# Returns a random high five ASCII.

Here we have included a link to the example program that uses these functions. To run it from within the package, use: python -m pyMood.__main__

Otherwise use: python __main__.py

Team Members

• Francisco Cunningham - fctico11
• Ahmad Almesned - ahmadhcs
• Tanuj Sistla - tanuj123-cyber
• Abhi Vachani - avachani

Link to pyMood on the PyPI website.