ezapi-yelp


Nameezapi-yelp JSON
Version 0.4.10 PyPI version JSON
download
home_page
SummaryA Python wrapper for Yelp API
upload_time2024-02-06 06:07:32
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords yelp fusion
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <div align="center">
    <img src="https://cdn2.iconfinder.com/data/icons/social-media-applications/64/social_media_applications_28-yelp-512.png" alt="yelp" height="96">
</div>

# ezapi-yelp

[![pytest](https://github.com/zehengl/ezapi-yelp/actions/workflows/pytest.yml/badge.svg)](https://github.com/zehengl/ezapi-yelp/actions/workflows/pytest.yml)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
![PyPI - License](https://img.shields.io/pypi/l/ezapi-yelp.svg)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ezapi-yelp.svg)
[![Downloads](https://static.pepy.tech/badge/ezapi-yelp)](https://pepy.tech/project/ezapi-yelp)
[![GitHub Pages](https://github.com/zehengl/ezapi-yelp/actions/workflows/gh-deploy.yml/badge.svg)](https://github.com/zehengl/ezapi-yelp/actions/workflows/gh-deploy.yml)

A Python wrapper for [Yelp Fusion API](https://docs.developer.yelp.com/docs/fusion-intro)

## Install

From [PyPi](https://pypi.org/project/ezapi-yelp/)

    pip install ezapi-yelp

From [GitHub](https://github.com/zehengl/ezapi-yelp)

    pip install git+https://github.com/zehengl/ezapi-yelp.git

## Usage

```python
from yelp import YelpFusion

token = "..."

yelp_fusion = YelpFusion(token)

print(yelp_fusion.business_search(location="San Francisco"))
print(yelp_fusion.transaction_search("delivery", location="San Francisco"))
print(yelp_fusion.business_details("WavvLdfdP6g8aZTtbBQHTw"))
print(
    yelp_fusion.business_match(
        name="Gary Danko",
        address1="800 N Point St",
        city="San Francisco",
        state="CA",
        country="US",
    )
)
print(yelp_fusion.reviews("WavvLdfdP6g8aZTtbBQHTw"))
print(
    yelp_fusion.autocomplete(
        text="Gary Danko", latitude=37.80587, longitude=-122.42058
    )
)
print(yelp_fusion.all_categories())
print(yelp_fusion.category_details("hotdogs"))
print(yelp_fusion.event_lookup("oakland-saucy-oakland-restaurant-pop-up"))
print(yelp_fusion.event_search(location="Oakland"))
print(yelp_fusion.featured_event(location="Oakland"))
```

## Test

```bash
git clone git@github.com:zehengl/ezapi-yelp.git
cd ezapi-yelp
export yelp_token="..."
python -m venv .venv
source .venv/bin/activate
pip install -e .
pip install -r requirements-test.txt
pytest
```

Use `$Env:yelp_token="..."` to set the api key environment variable on Windows.

## Credits

- [Icon][1] by [tulpahn][2]

[1]: https://www.iconfinder.com/icons/4102600/applications_media_social_yelp_icon
[2]: https://www.iconfinder.com/tulpahn

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "ezapi-yelp",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "Zeheng Li <imzehengl@gmail.com>",
    "keywords": "Yelp Fusion",
    "author": "",
    "author_email": "Zeheng Li <imzehengl@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/d3/59/47d713018d7b1e3a9d0069df440f4af9d58c853de8880b83ba3320d6d829/ezapi-yelp-0.4.10.tar.gz",
    "platform": null,
    "description": "<div align=\"center\">\n    <img src=\"https://cdn2.iconfinder.com/data/icons/social-media-applications/64/social_media_applications_28-yelp-512.png\" alt=\"yelp\" height=\"96\">\n</div>\n\n# ezapi-yelp\n\n[![pytest](https://github.com/zehengl/ezapi-yelp/actions/workflows/pytest.yml/badge.svg)](https://github.com/zehengl/ezapi-yelp/actions/workflows/pytest.yml)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n![PyPI - License](https://img.shields.io/pypi/l/ezapi-yelp.svg)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ezapi-yelp.svg)\n[![Downloads](https://static.pepy.tech/badge/ezapi-yelp)](https://pepy.tech/project/ezapi-yelp)\n[![GitHub Pages](https://github.com/zehengl/ezapi-yelp/actions/workflows/gh-deploy.yml/badge.svg)](https://github.com/zehengl/ezapi-yelp/actions/workflows/gh-deploy.yml)\n\nA Python wrapper for [Yelp Fusion API](https://docs.developer.yelp.com/docs/fusion-intro)\n\n## Install\n\nFrom [PyPi](https://pypi.org/project/ezapi-yelp/)\n\n    pip install ezapi-yelp\n\nFrom [GitHub](https://github.com/zehengl/ezapi-yelp)\n\n    pip install git+https://github.com/zehengl/ezapi-yelp.git\n\n## Usage\n\n```python\nfrom yelp import YelpFusion\n\ntoken = \"...\"\n\nyelp_fusion = YelpFusion(token)\n\nprint(yelp_fusion.business_search(location=\"San Francisco\"))\nprint(yelp_fusion.transaction_search(\"delivery\", location=\"San Francisco\"))\nprint(yelp_fusion.business_details(\"WavvLdfdP6g8aZTtbBQHTw\"))\nprint(\n    yelp_fusion.business_match(\n        name=\"Gary Danko\",\n        address1=\"800 N Point St\",\n        city=\"San Francisco\",\n        state=\"CA\",\n        country=\"US\",\n    )\n)\nprint(yelp_fusion.reviews(\"WavvLdfdP6g8aZTtbBQHTw\"))\nprint(\n    yelp_fusion.autocomplete(\n        text=\"Gary Danko\", latitude=37.80587, longitude=-122.42058\n    )\n)\nprint(yelp_fusion.all_categories())\nprint(yelp_fusion.category_details(\"hotdogs\"))\nprint(yelp_fusion.event_lookup(\"oakland-saucy-oakland-restaurant-pop-up\"))\nprint(yelp_fusion.event_search(location=\"Oakland\"))\nprint(yelp_fusion.featured_event(location=\"Oakland\"))\n```\n\n## Test\n\n```bash\ngit clone git@github.com:zehengl/ezapi-yelp.git\ncd ezapi-yelp\nexport yelp_token=\"...\"\npython -m venv .venv\nsource .venv/bin/activate\npip install -e .\npip install -r requirements-test.txt\npytest\n```\n\nUse `$Env:yelp_token=\"...\"` to set the api key environment variable on Windows.\n\n## Credits\n\n- [Icon][1] by [tulpahn][2]\n\n[1]: https://www.iconfinder.com/icons/4102600/applications_media_social_yelp_icon\n[2]: https://www.iconfinder.com/tulpahn\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A Python wrapper for Yelp API",
    "version": "0.4.10",
    "project_urls": {
        "homepage": "https://zehengl.github.io/ezapi-yelp/",
        "repository": "https://github.com/zehengl/ezapi-yelp"
    },
    "split_keywords": [
        "yelp",
        "fusion"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f200a4cf49791b7b581af6b8146898446ee68f78fb03ba54a8d1c3666d5799e0",
                "md5": "a8114d2d72a88ac126d30717347f445b",
                "sha256": "ca776f6f10ed55e9f549d807d82da8aad25dbd2849f112f3beffed43efc8b15d"
            },
            "downloads": -1,
            "filename": "ezapi_yelp-0.4.10-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "a8114d2d72a88ac126d30717347f445b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 4845,
            "upload_time": "2024-02-06T06:07:30",
            "upload_time_iso_8601": "2024-02-06T06:07:30.441847Z",
            "url": "https://files.pythonhosted.org/packages/f2/00/a4cf49791b7b581af6b8146898446ee68f78fb03ba54a8d1c3666d5799e0/ezapi_yelp-0.4.10-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d35947d713018d7b1e3a9d0069df440f4af9d58c853de8880b83ba3320d6d829",
                "md5": "3b4aaeff14bc080ac0e246a28ac87f0e",
                "sha256": "fc808cd8b4c05f9bf57ec08052ce0d3188d7dc0ad2e8b87cac97c6e0855ffccf"
            },
            "downloads": -1,
            "filename": "ezapi-yelp-0.4.10.tar.gz",
            "has_sig": false,
            "md5_digest": "3b4aaeff14bc080ac0e246a28ac87f0e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 8746,
            "upload_time": "2024-02-06T06:07:32",
            "upload_time_iso_8601": "2024-02-06T06:07:32.143174Z",
            "url": "https://files.pythonhosted.org/packages/d3/59/47d713018d7b1e3a9d0069df440f4af9d58c853de8880b83ba3320d6d829/ezapi-yelp-0.4.10.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-02-06 06:07:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "zehengl",
    "github_project": "ezapi-yelp",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "ezapi-yelp"
}
        
Elapsed time: 0.19007s