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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for python_urbandict-0.3.11.tar.gz
Algorithm Hash digest
SHA256 70e78cdd979cf28b5cd67d73ef586fe6165230e2af03de1c650acebb9b9ec19b
MD5 01c88630281dba47a148e222a611c405
BLAKE2b-256 a896dc49c55858b79f2cac788661a937fa1305f5923c22570613d10b251c70e1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_urbandict-0.3.11-py3-none-any.whl
Algorithm Hash digest
SHA256 f4e608cbc78303d7a6a70aa5820d1c1b9b73f08d27c4dee5ae0d0d9c7d69434f
MD5 e7d3d603ed75637642cecf35fb1857e2
BLAKE2b-256 5dee8e6b7b8a6f4908bfd87e7c924090612aca3fef3224d790d825b14480e7bf

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 Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page