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

Uploaded Source

Built Distribution

python_urbandict-0.3.10-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_urbandict-0.3.10.tar.gz
  • Upload date:
  • Size: 3.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for python_urbandict-0.3.10.tar.gz
Algorithm Hash digest
SHA256 13d3a4d023b9be601412b4c99b603b4c16d034a244f3e7b7d47a733bd809ee65
MD5 0c5d709def0651ea081dea75690ec5ff
BLAKE2b-256 44265bbd3cad0174248778bf688a17e34fb55b05c96f5184e13202660f742828

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_urbandict-0.3.10-py3-none-any.whl
Algorithm Hash digest
SHA256 a14fe6777d1bce6c646bde475cae39a4577018771cad53fcfdc87a70d269e664
MD5 aedc50214b0ce1d50a1915111d588bb8
BLAKE2b-256 6ac4b0c5211c5e19dfd1cd90041f8afc8b3ccf6e8760e6d3e366765b7a545e58

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