Skip to main content

Python wrapper for the Urban Dictionary API.

Project description

python-urbandict

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.10 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

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

Uploaded Source

File details

Details for the file python-urbandict-0.1.2.tar.gz.

File metadata

  • Download URL: python-urbandict-0.1.2.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.2

File hashes

Hashes for python-urbandict-0.1.2.tar.gz
Algorithm Hash digest
SHA256 3cbdf2608e1fbc15deb839874ccfed79177e6f751e74c121b100dc6e8d0cda02
MD5 032e06cdc5bef8bef768973676728cb5
BLAKE2b-256 578d44413e8c90a51314c39369667e3a561a8bdd80d86e09061540638afe8c21

See more details on using hashes here.

Supported by

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