yoyo-bgw

A cozy Python package with greetings, bedtime stories, quotes, and friendly messages.

Created by Youssef.

Requirements

• + Python 3.11

Installation

Install the package:

pip install yoyo-bgw

Update the package:

pip install --upgrade yoyo-bgw

What is this package?

yoyo-bgw is a friendly Python package that provides:

Welcome messages

Goodbye messages

Morning greetings

Bedtime stories

Motivational quotes

JSON-powered random content...

The package is designed to be simple, cozy, and beginner-friendly.

Using the package and its classes

How to use this package:

Import it:

from yoyo import Yoyo

Then create the object:

from yoyo import Yoyo

example_name = Yoyo(
                name='Example',
                age=12,
                height=12,
                weight=13,
                eye_color='blue',
                hair_color='black',
                gender='male',
                nickname='Example'
)

Functions

• welcome() welcomes you
• good_morning() gives you a morning quote
• good_afternoon() gives you an afternoon quote
• good_evening() gives you an evening quote
• good_night() tells you a bedtime story
• auto_greet() calls the specific function depending on the time and season
• bye() tells you goodbye

Example Usage:

from yoyo import Yoyo

person = Yoyo(
    name="Youssef",
    nickname="Yoyo"
)

print(person.welcome())

Example Output:

Welcome Youssef!
Or welcome Yoyo!

How to use the Timer class

Import it:

from yoyo import Timer

Then create the object:

from yoyo import Timer

timer = Timer() # No parameters required currently

Functions:

• countdown(count, time_type, show)

Enter the count amount,

then if it is min/hour/sec.

The show parameter allows custom output systems such as:

• print
• pyttsx3 speech
• Tkinter labels
• custom logging functions

Example Usage:

from yoyo import Timer

timer = Timer()
timer.countdown(10, 'sec', print)
timer.pomodoro(work_time=25, break_time=5, long_break_time=25, show=print)

Example Output:

00:10
00:09
00:08
...
Time's Up!

💻 Work Time
25:00
...
00:01

☕ Short Break Time
05:00
...
00:01

⏰ Long Break Time
25:00

How to use the TextStudio class

Import it:

from yoyo import TextStudio

Then create the object:

from yoyo import TextStudio

text_editor = TextStudio(
    text='Blah-blAh-TExt'
)

Functions:

• to_morse()
• to_upper()
• to_title()
• to_lower()
• space_out_letters()
• replace_with_spaces()
• caeser()
• reverse()
• word_count()
• char_count()
• remove_spaces()
• snake()
• camel()
• caeser()
• remove_panctuations()

Example Usage:

from yoyo import TextStudio

text_editor = TextStudio(
    text="Blah-blAh-TExt"
)
print(text_editor.to_lower())
print(text_editor.to_upper())
print(text_editor.to_title())
print(text_editor.replace_with_spaces(replacement='-')) # Replacement is the letter you're gonna replace with spaces.
print(text_editor.space_out_letters())

Example Output:

blah-blah-text
BLAH-BLAH-TEXT
Blah-Blah-Text
Blah blAh TExt
B l a h  b l A h  T E x t