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.4.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

jokepie-1.0.4-py3-none-any.whl (5.5 kB view details)

Uploaded Python 3

File details

Details for the file jokepie-1.0.4.tar.gz.

File metadata

  • Download URL: jokepie-1.0.4.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for jokepie-1.0.4.tar.gz
Algorithm Hash digest
SHA256 732742a36a6f362ac8a2564598e5d2eb76ed15f8769b86c6158a80e9b0b55cc6
MD5 b2f31204ed317b33248c59e6df01f4d2
BLAKE2b-256 4496246d54c7568feac3c1633dfd1cc2e76c18a0b66da7c8161bab0226b0e740

See more details on using hashes here.

File details

Details for the file jokepie-1.0.4-py3-none-any.whl.

File metadata

  • Download URL: jokepie-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 5.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.9

File hashes

Hashes for jokepie-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b8c2df46fcc19aaaa6da6c980e1184414b2e54162e59e2c22d823a6edcb4935f
MD5 18cbc2733b957963c72ba8611ffa1842
BLAKE2b-256 68dc0870ba5c2dfd02665c12f9b1fc1f457985468a25c35ffdbf459b27326710

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