python-urbandict


Namepython-urbandict JSON
Version 0.3.10 PyPI version JSON
download
home_pagehttps://github.com/atbuy/pyurbandict
SummaryPython wrapper for the Urban Dictionary API.
upload_time2024-07-07 15:45:29
maintainerNone
docs_urlNone
authoratbuy
requires_python<4.0,>=3.9
licenseMIT
keywords urban dictionary api wrapper python
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # python-urbandict

[![version](https://img.shields.io/pypi/v/python-urbandict.svg)](https://pypi.org/project/python-urbandict/)
[![versions](https://img.shields.io/pypi/pyversions/python-urbandict.svg)](https://pypi.org/project/python-urbandict/)
[![Python package](https://github.com/atbuy/pyurbandict/actions/workflows/python-package.yml/badge.svg)](https://github.com/atbuy/pyurbandict/actions/workflows/python-package.yml)
[![codecov](https://codecov.io/gh/atbuy/pyurbandict/branch/main/graph/badge.svg?token=A244XBTUVH)](https://codecov.io/gh/atbuy/pyurbandict)

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.

```python
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
* [PyPi](https://pypi.org/project/python-urbandict/)


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/atbuy/pyurbandict",
    "name": "python-urbandict",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": "urban, dictionary, api, wrapper, python",
    "author": "atbuy",
    "author_email": "buy@atbuy.dev",
    "download_url": "https://files.pythonhosted.org/packages/44/26/5bbd3cad0174248778bf688a17e34fb55b05c96f5184e13202660f742828/python_urbandict-0.3.10.tar.gz",
    "platform": null,
    "description": "# python-urbandict\n\n[![version](https://img.shields.io/pypi/v/python-urbandict.svg)](https://pypi.org/project/python-urbandict/)\n[![versions](https://img.shields.io/pypi/pyversions/python-urbandict.svg)](https://pypi.org/project/python-urbandict/)\n[![Python package](https://github.com/atbuy/pyurbandict/actions/workflows/python-package.yml/badge.svg)](https://github.com/atbuy/pyurbandict/actions/workflows/python-package.yml)\n[![codecov](https://codecov.io/gh/atbuy/pyurbandict/branch/main/graph/badge.svg?token=A244XBTUVH)](https://codecov.io/gh/atbuy/pyurbandict)\n\nThis is a python project, that fetches definitions of words from urban dictionary's public API.\n\nFuture additions. PRs are always welcome :)\n* Calculate ratio of `thumbs_up` and `thumbs_down` and decide the probability of a correct definition.\n\n# Installation\n\n*Python 3.9 or higher is required*\n\nTo install the library you can use the following command:\n\n```\n# Linux/MacOS\npython3 -m pip install --upgrade python-urbandict\n\n# Windows\npy -3 -m pip install --upgrade python-urbandict\n```\n\nOr just try:\n\n```\npip install python-urbandict\n```\n\n# Quick Example\n\nYou 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.\nIf you want to you can also leave the word attribute empty, in which case a random word is selected by UrbanDictionary.\n\n```python\nfrom pyurbandict import UrbanDict\n\nword = UrbanDict(\"python\")\nresults = word.search()\nprint(results[0])\n\n>>> Definition(\n    word='python',\n    definition='The best thing to happen to [Computer Science] students in a data and [file] structures or [algorithms] class.',\n    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?\"',\n    author='TheNextBillGates',\n    thumbs_up=243,\n    thumbs_down=71,\n    sound_urls=['https://api.twilio.com/2008-08-01/Accounts/ACd09691b82112e4b26fce156d7c01d0ed/Recordings/RE7065a4ef810937cc16ae2b6e4b54b67d'],\n    written_on='2010-03-24T05:24:18.000Z',\n    permalink='http://python.urbanup.com/4826760',\n    defid=4826760,\n    current_vote=''\n)\n```\n\n# Links\n* [PyPi](https://pypi.org/project/python-urbandict/)\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python wrapper for the Urban Dictionary API.",
    "version": "0.3.10",
    "project_urls": {
        "Bug Tracker": "https://github.com/atbuy/pyurbandict/issues",
        "CI/CD": "https://github.com/atbuy/pyurbandict/actions",
        "Homepage": "https://github.com/atbuy/pyurbandict",
        "Repository": "https://github.com/atbuy/pyurbandict",
        "Source Code": "https://github.com/atbuy/pyurbandict"
    },
    "split_keywords": [
        "urban",
        " dictionary",
        " api",
        " wrapper",
        " python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6ac4b0c5211c5e19dfd1cd90041f8afc8b3ccf6e8760e6d3e366765b7a545e58",
                "md5": "aedc50214b0ce1d50a1915111d588bb8",
                "sha256": "a14fe6777d1bce6c646bde475cae39a4577018771cad53fcfdc87a70d269e664"
            },
            "downloads": -1,
            "filename": "python_urbandict-0.3.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "aedc50214b0ce1d50a1915111d588bb8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 5170,
            "upload_time": "2024-07-07T15:45:28",
            "upload_time_iso_8601": "2024-07-07T15:45:28.024524Z",
            "url": "https://files.pythonhosted.org/packages/6a/c4/b0c5211c5e19dfd1cd90041f8afc8b3ccf6e8760e6d3e366765b7a545e58/python_urbandict-0.3.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "44265bbd3cad0174248778bf688a17e34fb55b05c96f5184e13202660f742828",
                "md5": "0c5d709def0651ea081dea75690ec5ff",
                "sha256": "13d3a4d023b9be601412b4c99b603b4c16d034a244f3e7b7d47a733bd809ee65"
            },
            "downloads": -1,
            "filename": "python_urbandict-0.3.10.tar.gz",
            "has_sig": false,
            "md5_digest": "0c5d709def0651ea081dea75690ec5ff",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 3269,
            "upload_time": "2024-07-07T15:45:29",
            "upload_time_iso_8601": "2024-07-07T15:45:29.636621Z",
            "url": "https://files.pythonhosted.org/packages/44/26/5bbd3cad0174248778bf688a17e34fb55b05c96f5184e13202660f742828/python_urbandict-0.3.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-07 15:45:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "atbuy",
    "github_project": "pyurbandict",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "python-urbandict"
}
        
Elapsed time: 1.61131s