https://github.com/loisakitakaya/jokes
Python wrapper for jokes APIs
https://github.com/loisakitakaya/jokes
api-wrapper jokes jokes-api pypi-package python3
Last synced: 4 days ago
JSON representation
Python wrapper for jokes APIs
- Host: GitHub
- URL: https://github.com/loisakitakaya/jokes
- Owner: LoisaKitakaya
- License: mit
- Created: 2023-06-06T15:43:54.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-06-23T06:59:26.000Z (almost 2 years ago)
- Last Synced: 2025-04-16T12:23:25.146Z (8 days ago)
- Topics: api-wrapper, jokes, jokes-api, pypi-package, python3
- Language: Python
- Homepage: https://pypi.org/project/py-jokes-py/
- Size: 39.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# py-jokes-py
Python wrapper for the jokes APIs provided by:
- [icanhazdadjokes.com](https://icanhazdadjoke.com/)
- [jokeapi.dev](https://jokeapi.dev/)
## How to install
```
pip install py-jokes-py
```
## Usage
Something to note, the `jokes` module has two classes:
- `DadJokes()` - wrapper for [icanhazdadjokes.com](https://icanhazdadjoke.com/) api
- `AllJokes()` - wrapper for [jokeapi.dev](https://jokeapi.dev/) api
##### Class `DadJokes()`
This class provides the following methods:
- `random_joke_as_json(self)`
- `random_joke_as_text(self)`
- `specific_joke_as_json(self, id)`
- `specific_joke_as_text(self, id)`
- `list_jokes_as_json(self, page, limit, term)`
- `list_jokes_as_text(self, page, limit, term)`
##### Class `AllJokes()`
This class inherits from the `DadJokes` class, but also provides the following methods:
- `get_joke_json(self, joke_lang, joke_category, joke_flags, joke_type, joke_contains, joke_id, joke_amount)`
- `get_joke_text(self, joke_lang, joke_category, joke_flags, joke_type, joke_contains, joke_id, joke_amount)`
#### Basic Usage
```
from jokes.jokesv2 import AllJokes
jokes = AllJokes()
joke = jokes.get_joke_json()
print(joke)
joke = jokes.get_joke_text()
print(joke)
joke = jokes.random_joke_as_json()
print(joke)
joke = jokes.random_joke_as_text()
print(joke)
joke = jokes.specific_joke_as_json(id="12")
print(joke)
joke = jokes.specific_joke_as_text(id="12")
print(joke)
joke = jokes.list_jokes_as_json()
print(joke)
joke = jokes.list_jokes_as_text()
print(joke)
```
## Example
Here is a simple implementation of this package. Check it out:
- [jokes_cli](https://github.com/LoisaKitakaya/jokes_cli)
## Contribution
If you want to contribute to this project, here are some few steps you can follow:
- Fork this project's repository
- Clone it to your local machine
- Make the changes you want to make or add the features you want to add
- Write tests for the new features
- Make a pull request
That's just about it.
## Issues
For any issus encountered while using this package, feel free to submit a new issue [here](https://github.com/LoisaKitakaya/Jokes/issues).
Enjoy! 🤪