Skip to main content

The basic library for coding

Project description

cozy-kit

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 cozy_kit import Yoyo

Then create the object:

from cozy_kit 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 cozy_kit 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 cozy_kit import Timer

Then create the object:

from cozy_kit 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 cozy_kit 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 cozy_kit import TextStudio

Then create the object:

from cozy_kit 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 cozy_kit 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cozy_kit-0.2.3.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cozy_kit-0.2.3-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file cozy_kit-0.2.3.tar.gz.

File metadata

  • Download URL: cozy_kit-0.2.3.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for cozy_kit-0.2.3.tar.gz
Algorithm Hash digest
SHA256 7dbdb2970d838e2c376fc4e6a9d41f7c3cbe8b3ed0c05f1966c086896e0efa7c
MD5 0da5108b64abbed2d11d183da236c7f4
BLAKE2b-256 f19a703f412eaefc7d6752e5ddaf576af6d23f9e36d2daf3f9853108349b65d2

See more details on using hashes here.

File details

Details for the file cozy_kit-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: cozy_kit-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 5.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.9

File hashes

Hashes for cozy_kit-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 cf68b27b636f98f364ed40cdf48b819ec6be92ca6a924e4ce76ebfec60dfb1e1
MD5 481a9b4aef266ac995e9dcd495e65005
BLAKE2b-256 4bacf7cac4fb3161316c3fc3a2cda4c7b3257e19f30f473bee0665e3b9f4cfbe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page