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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file py_jokes_py-1.1.2.tar.gz.

File metadata

  • Download URL: py_jokes_py-1.1.2.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.6 Linux/5.15.0-72-generic

File hashes

Hashes for py_jokes_py-1.1.2.tar.gz
Algorithm Hash digest
SHA256 0938b6bf988eb957e04b0d4c235b95d4ba856532c287d9f7258bfef74221f219
MD5 a1d1cef1e46674ef0a9b7bbc30cab61a
BLAKE2b-256 6150cf6663387a738285ac7961e8e160418d21b8333d9435c666233185a5ad05

See more details on using hashes here.

File details

Details for the file py_jokes_py-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: py_jokes_py-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.10.6 Linux/5.15.0-72-generic

File hashes

Hashes for py_jokes_py-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 14400d75be67192c5a517581f616e15fca9b3f157c752ddfd4f03cfd33b82595
MD5 951a48c4787d037868d89f4fdf8a5de9
BLAKE2b-256 c5ade1479e7962459dc6d44f87c2c230a3c428c88a562266cba1e58829786c1d

See more details on using hashes here.

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