Python wrapper for jokes APIs provided by icanhazdadjokes.com and jokeapi.dev
Project description
py-jokes-py
Python wrapper for the jokes APIs provided by:
How to install
pip install py-jokes-py
Usage
Something to note, the jokes
module has two classes:
DadJokes()
- wrapper for icanhazdadjokes.com apiAllJokes()
- wrapper for 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:
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.
Enjoy! 🤪
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
py_jokes_py-1.1.3.tar.gz
(4.2 kB
view hashes)
Built Distribution
Close
Hashes for py_jokes_py-1.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d63f1f8f2fb12a1ba870255435f4e804025ccca2cf43faba31caeb891f18b1b |
|
MD5 | e5b8bd69aafb6efd42848f139ec91a8c |
|
BLAKE2b-256 | a0e0504610ac8206b7800c7cf0c22670bb1b3d3a6bd28edf66aa11c70bb14f3e |