devmood 0.1.0

Emotional support for developers

devmood - Emotional Support for Developers

devmood is a playful Python package that gives developers quick emotional support during coding sessions.
It helps turn debugging stress into momentum with encouragement, small-win celebrations, sarcastic advice, and ASCII hugs.

Project Description

devmood includes four functions that all accept arguments and return a str:

• debug_encouragement(error_type: str) -> str
  Returns a supportive message based on the error type.
• celebrate_small_win(task: str) -> str
  Celebrates progress for a completed coding task.
• passive_aggressive_advice(topic: str) -> str
  Returns playful sarcastic advice tied to a topic.
• ascii_hug(name: str) -> str
  Returns a personalized ASCII hug.

PyPI

Install and Import

Install from PyPI:

pip install devmood

Import in your own project:

from devmood import (
    debug_encouragement,
    celebrate_small_win,
    passive_aggressive_advice,
    ascii_hug,
)

Function Documentation and Exact Examples

debug_encouragement(error_type: str) -> str

from devmood import debug_encouragement

message = debug_encouragement("TypeError")
print(message)

celebrate_small_win(task: str) -> str

from devmood import celebrate_small_win

message = celebrate_small_win("wrote my first passing test")
print(message)

passive_aggressive_advice(topic: str) -> str

from devmood import passive_aggressive_advice

message = passive_aggressive_advice("variable naming")
print(message)

ascii_hug(name: str) -> str

from devmood import ascii_hug

message = ascii_hug("Laura")
print(message)

Example Program Using All Functions

• Example script: example.py

Run it:

python example.py

Contributing and Local Development

1) Clone and enter the project

git clone https://github.com/swe-students-spring2026/3-package-scarlet_macaw.git
cd 3-package-scarlet_macaw

2) Set up virtual environment and dependencies

pip install pipenv
pipenv install --dev
pipenv shell

3) Run tests

pytest

4) Build package artifacts

python -m build

5) Collaboration workflow

git checkout -b feature/your-feature-name
# make changes
pytest
git add .
git commit -m "Describe your change"
git push -u origin feature/your-feature-name

Then open a Pull Request to main and request teammate review.

Cross-Platform Run Instructions

These commands work on macOS, Linux, and Windows (PowerShell), as long as Python 3.9+ and pip are installed:

1. pip install pipenv
2. pipenv install --dev
3. pipenv run pytest
4. pipenv run python example.py

Environment Variables and Starter Data

Secret Configuration Files

Teammates

• Laura Liu
• Yutong Liu
• Bryce Lin
• Yuliang Liu
• Teammate Five