Skip to main content

API Wrapper for sv443's joke api

Project description

JokeAPI Wrapper by TheWever

Import jokeapie

import jokepie # imports package

Create a client

client = jokepie.Client() # returns client objects

Get a joke

joke = client.get_joke() # returns Joke object

Post a joke

client.upload_joke('Insert Joke', 'category') # returns True on exception

Sample:

import jokepie
client = jokepie.Client()
joke = client.get_joke('dog')
print(joke.joke)

Docs

Joke Objetct:

  • Category # returns
  • joke_type # returns str
  • joke # returns str or list
  • flags # returns list
  • id # returns int
  • safe # return bool
  • language / lang # returns str
  • request # returns req resp object
  • get_joke() # returns joke or dict

Client Object:

  • get_joke(content='', lang='english', categories: list=['any'], blacklist=[], joke_type='single', safe_mode=False, id_range=[], amount: int = 1) # returns Joke Object
  • upload_joke(joke: str or dict, category, joke_type='single', lang='english', on_flags=[]) # returns bool

--

Notes:

Given Args

Most arguments are not required but should be checked especially before uploading a joke

Sequence Matcher

When you provide an invalid argument like inglish as language the best match will be choosen using SequenceMatcher

Uploading jokes

When you want to upload a joke of the type twopart provide a list[setup, delivery] as joke else str(joke)

Updates and async

This libary will not recive any updates only patches and is not asynchronous

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

jokepie-1.0.5.tar.gz (5.4 kB view hashes)

Uploaded Source

Built Distribution

jokepie-1.0.5-py3-none-any.whl (5.5 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