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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_urbandict-0.3.15-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: python_urbandict-0.3.15.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for python_urbandict-0.3.15.tar.gz
Algorithm Hash digest
SHA256 8f5d5d0d79badc82ed3c2342fdc8dc46c2f804a93b3d0ededfa3238bbdd57219
MD5 56dd7279cf09584acf698a0e3a6a4040
BLAKE2b-256 e6909ac2a296eb1f6469c1bfed948fc11ad416cdefcba90d0f4ff4c282d37135

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_urbandict-0.3.15-py3-none-any.whl
Algorithm Hash digest
SHA256 eb1132ef8990d62cdced614f144efa357a27ccbdb9bf595a2be19a6172d01ec2
MD5 5ce3bca5beb9f28bdaddd7cc9dcc8106
BLAKE2b-256 8db1e9b568878f556d949f2584b59bc7761319b975fecaaff1740f931bb44916

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