Metadata-Version: 2.4
Name: cozy-kit
Version: 0.2.6
Summary: The basic library for coding
Author: youssefahmed2017
License: MIT
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# [cozy-kit](https://pypi.org/project/cozy-kit/)

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

#### Created by Youssef.

---

# Requirements
- #### + Python 3.8

---

# Installation

#### Install the package:

```bash
pip install cozy-kit
```
---
#### Update the package:
```bash
pip install --upgrade cozy-kit
```
---

## What is this package?

### [cozy-kit](https://pypi.org/project/cozy-kit/) 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:

```python
from cozy_kit import Yoyo
```
---
### Then create the object:

```python
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
- `motivate()` gives you a motivational quote
- `fun_facts()` gives you a fun fact
---

## Example Usage:

```python
from cozy_kit import Yoyo

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

print(person.say())
```
---

## Example Output:
```text
Welcome Youssef!
Or welcome Yoyo!
```
---

## How to use the Timer class
### Import it:

```python
from cozy_kit import Timer
```
---

### Then create the object:

```python
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


- `pomodoro(work_time, break_time, long_break_time, show)` The work, break, and long_break times will be calculated as minutes
- `wait(count, time_type)`
- `get_time()`
- `start_stopwatch()`
- `end_stopwatch()`

---

## Example Usage:

```python
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)
```

---

# How to use the TextStudio class
## Import it:

```python
from cozy_kit import TextStudio
```
---

## Then create the object:

```python
from cozy_kit import TextStudio

text_editor = TextStudio()
```
---
## Functions:

- `to_morse(text)`
- `to_upper(text)`
- `to_title(text)`
- `to_lower(text)`
- `space_out_letters(text)`
- `replace_with_spaces(text, replacement)`
- `caesar(text, shift)`
- `reverse(text)`
- `word_count(text)`
- `char_count(text)`
- `remove_spaces(text)`
- `snake(text)`
- `remove_punctuation(text)`
