Metadata-Version: 2.4
Name: JokesDB
Version: 0.1.2
Summary: A simple Python module to fetch jokes from my website.
Author-email: Code2Craft <support@code2craft.xyz>
License: MIT License
        
        Copyright (c) 2025 Code2Craft
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://code2craft.xyz
Project-URL: Source, https://github.com/gamercristi11/JokesDB
Project-URL: Docs, https://code2craft.xyz/jokesdb/docs.html
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Dynamic: license-file

# JokesDB

A simple Python module to fetch jokes from my website.

## Chapters
- [Links](#links)
- [Installation](#installation)
- [Usage](#usage)
  - [1. Get jokes randomly](#1-get-jokes-randomly)
  - [2. Get today's joke](#2-get-todays-joke)
  - [3. Get cat.json file](#3-get-catjson-file)
- [Requirements](#requirements)
- [License](#license)

## Links
- [PyPI Project Page](https://pypi.org/project/JokesDB/)
- [Docs](https://code2craft.xyz/jokesdb/docs.html)
- [Website](https://code2craft.xyz)
- [Source code](https://github.com/gamercristi11/jokesdb)

## Installation

```sh
pip install jokesdb
```

## Usage

### 1. Get jokes randomly

```python
get_jokes(number=1, category="all")
```
Parameters:**
- `number`: Number of random jokes to get (Default = 1)
- `category`: Category to get jokes from. Categories: all, or those available at [cat.json](https://code2craft.xyz/jokesdb/cat.json) or via `catfile()` (Default = "all")

Example of use:
```python
from jokesdb import get_jokes

joke = get_jokes()
print(joke)
```
### 2. Get todays joke

```python
joke_of_the_day()
```
Example of use:
```python
from jokesdb import joke_of_the_day

todays_joke = joke_of_the_day()
print(todays_joke)
```

### 3. Get cat.json file
```python
catfile()
```

Example of use:
```python
from jokesdb import catfile

catfile = catfile()
print(catfile)
```

## Requirements

- Python 3.6+
- requests

## License
MIT License
