moodsmith 1.0.1

A package designed to motivate you while you work, directly in your terminal.

Moodsmith

Pypi link: https://pypi.org/project/moodsmith

Setting Up a Virtual Environment and Installing Moodsmith

1. Install pipenv

If you don’t already have pipenv installed, run:

pip install pipenv

2. Activate the virtual environment

pipenv shell

3. Install Moodsmith

pipenv install moodsmith

To verify the installation, run

moodsmith --version

Moodsmith in the command line

For a list of all commands and available flags, type

moodsmith --help

Example Usage

---

Funny message

• For a funny message:

moodsmith -c funny

Available flags:

• --name (-n) : Name
• --enthusiasm (-e) : Enthusiasm (number of exclamation points after the message)
• --language (-l) : Language (en/fr/es)

Negative motivational message

• For a sarcastic message:

moodsmith -c negative 

Available flags:

• --name (-n) : Name
• --enthusiasm (-e) : Enthusiasm (number of exclamation points after the message)
• --intensity (-i) : Intensity (soft/medum/hard) (How sarcastic should the message be)
• --language (-l) : Language (en/fr/es)

Motivational message

• For a motivational message:

moodsmith -c motivational

Available flags:

• --name (-n) : Name
• --intensity (-i) : Intensity (soft, medium, hard) (How motivational should the message be)
• --language (-l) : Language (en/fr/es)

Positive message:

• For a positive message:

moodsmith -c positive

Available flags:

• --name (-n) : Name
• --enthusiasm (-e) : Enthusiasm (number of exclamation points after the message)
• --language (-l) : Language (en/fr/es)

---

Within a python program

• Import moodsmith using:

import moodsmith

• Alternatively, import specifically the needed functions from moodsmith. The below code imports all available functions.

from moodsmith import positive, negative, motivational, funny

Usage of moodsmith functions:

• Funny:

funny(name="name", enthusiasm=2, language="en", seed=22)

• Negative motivational:

negative(name="name", enthusiasm=0, intensity="hard", language="fr", seed=22)

• Motivational:

motivational(name="name", intensity="soft", language="es", seed=22)

• Positive:

positive(name="name", enthusiasm=5, language="en", seed=22)

Note that all arguments have defaults and none are required.

For an example python project using moodsmith, click here: example moodsmith program

Contributors

• Samuel Yang (https://github.com/SamuelYang24)
• Conor Tiernan (https://github.com/ct-04)
• Ganling Zhou (https://github.com/GanlingZ)
• Eason Huang (https://github.com/GILGAMESH605)
• Harrison Coon (https://github.com/hoc2006-code)