Metadata-Version: 2.4
Name: egyJokes
Version: 0.1.1
Summary: Egyptian jokes library
Author: Omnia Ayman
License: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# egyJokes 🎭

A simple Python package that returns random Egyptian jokes.

This is my first Python package, created to learn how to build, publish, and distribute a package on PyPI. The project is simple and made for practice while also providing a collection of Egyptian jokes.

## Features

- Get a random joke
- Get multiple random jokes
- Get a random joke from a category
- Search jokes by keyword
- Get a joke by its ID
- List all categories
- Show statistics for categories
- Access all jokes

---

## Installation

Install the package from PyPI:

```bash
pip install egyJokes
```

---

## Quick Start

```python
import egyJokes.jokes as jokes

print(jokes.random_joke())
```

---

## Available Functions

| Function | Description |
|----------|-------------|
| `random_joke()` | Return one random joke |
| `random_jokes(count)` | Return multiple random jokes |
| `random_by_category(category)` | Return a random joke from a category |
| `search(keyword)` | Search jokes by keyword |
| `get(id)` | Return a joke by its ID |
| `categories()` | Return all available categories |
| `count()` | Return the total number of jokes |
| `stats()` | Return the number of jokes in each category |
| `jokes()` | Return all jokes |

---

## About This Project

This is a small personal project that I created to learn:

- How to build a Python package
- How to publish a package on PyPI
- How to organize a Python project
- How to work with JSON data
- How to write package documentation

It is my first published Python package, so there is still room for improvement. I hope it can also help beginners who want to learn how Python packages work.

---

## License

This project is licensed under the MIT License.

---
