Skip to main content

Urban dictionary API wrapper for Python

Project description

urbandictionary-py

Simple Python wrapper for Urban Dictionary API.

Installation

With PyPI:

pip install udpy

Usage

UrbanDefinition

This module defines UrbanDefinition, an object to represent each Urban Dictionary definition. UrbanDefinition has the following accessible attributes:

  • word: the word being defined,
  • definition: the word's definition,
  • example: usage example,
  • upvotes: number of upvotes on Urban Dictionary,
  • downvotes: number of downvotes on Urban Dictionary

Examples

Create client:

from udpy import UrbanClient

client = UrbanClient()

Lookup by word:

defs = client.get_definition('netflix and chill')

>	[List of UrbanDef objects]

Lookup random words:

rand = client.get_random_definition()

>	[List of UrbanDef objects]

Read definitions:

for d in defs:
	print(d.definition)

>	It means that you are going to go over ...
>	code for two people going to each others ...
> 	<other Netflix and Chill definitions> ...

UrbanDefinition string representation:

for d in defs:
	print(d)

>	Netflix and Chill: It means that you are going to go over to your par... (21776, 7750)
>	netflix and chill: code for two people going to each others houses an... (8056, 2622)
>	<word>: <definition trimmed to 50 characters> (<upvotes>, <downvotes>)

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

udpy-1.0.0.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

udpy-1.0.0-py3-none-any.whl (4.2 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