Skip to main content

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:

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:

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.2.tar.gz (4.0 kB view hashes)

Uploaded Source

Built Distribution

py_jokes_py-1.1.2-py3-none-any.whl (5.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page