Skip to main content

Python wrapper for the Urban Dictionary API.

Project description

python-urbandict

version versions Python package codecov

This is a python project, that fetches definitions of words from urban dictionary's public API.

Future additions. PRs are always welcome :)

  • Calculate ratio of thumbs_up and thumbs_down and decide the probability of a correct definition.

Installation

Python 3.9 or higher is required

To install the library you can use the following command:

# Linux/MacOS
python3 -m pip install --upgrade python-urbandict

# Windows
py -3 -m pip install --upgrade python-urbandict

Or just try:

pip install python-urbandict

Quick Example

You can create an instance of the UrbanDict class and pass a word to it. After that you can use the search method that will retrieve the definitions from UrbanDictionary. If you want to you can also leave the word attribute empty, in which case a random word is selected by UrbanDictionary.

from pyurbandict import UrbanDict

word = UrbanDict("python")
results = word.search()
print(results[0])

>>> Definition(
    word='python',
    definition='The best thing to happen to [Computer Science] students in a data and [file] structures or [algorithms] class.',
    example='Joe: "Man...I spent a week coding that [algorithm] in C."\r\nMoe: "I got it [done in one] evening with [Python]. It works great."\r\nJoe: "Say, what? Where can I download that?"',
    author='TheNextBillGates',
    thumbs_up=243,
    thumbs_down=71,
    sound_urls=['https://api.twilio.com/2008-08-01/Accounts/ACd09691b82112e4b26fce156d7c01d0ed/Recordings/RE7065a4ef810937cc16ae2b6e4b54b67d'],
    written_on='2010-03-24T05:24:18.000Z',
    permalink='http://python.urbanup.com/4826760',
    defid=4826760,
    current_vote=''
)

Links

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

python_urbandict-0.3.12.tar.gz (3.2 kB view details)

Uploaded Source

Built Distribution

python_urbandict-0.3.12-py3-none-any.whl (3.9 kB view details)

Uploaded Python 3

File details

Details for the file python_urbandict-0.3.12.tar.gz.

File metadata

  • Download URL: python_urbandict-0.3.12.tar.gz
  • Upload date:
  • Size: 3.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.23

File hashes

Hashes for python_urbandict-0.3.12.tar.gz
Algorithm Hash digest
SHA256 863c2c09f1bc80232ce6422cdd55a6683de2772f349ea49aa4ddbca6df725417
MD5 3b82fdb2fa257fa741761692d2e91cb9
BLAKE2b-256 ae1ef6fa4bf70ea28b4872c8ad3e6c2e1e6a6d642e69c3681cace0eff3aed77e

See more details on using hashes here.

File details

Details for the file python_urbandict-0.3.12-py3-none-any.whl.

File metadata

File hashes

Hashes for python_urbandict-0.3.12-py3-none-any.whl
Algorithm Hash digest
SHA256 e15ae41ae66118308a92f6652f9eee6f626700e6c008042bcbb3cac7edeee109
MD5 53ead4362dceb3dfe2522eb304791bbd
BLAKE2b-256 d24e5f60954a2a9e852e1c4d788e73847cdb914cc13bd4689c254ac53225597c

See more details on using hashes here.

Supported by

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