https://github.com/mraza007/yelp-cli

Yelp cli that is designed to lookup restaurants on the commad line
https://github.com/mraza007/yelp-cli

Last synced: 6 months ago
JSON representation

Yelp cli that is designed to lookup restaurants on the commad line

• Host: GitHub
• URL: https://github.com/mraza007/yelp-cli
• Owner: mraza007
• License: mit
• Created: 2019-03-21T14:08:46.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-08T04:56:46.000Z (about 3 years ago)
• Last Synced: 2025-02-11T13:22:33.901Z (11 months ago)
• Language: Python
• Size: 19.5 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# yelp-cli

This is an interactive CLI tool that helps you find restaurants in your city/area. This project uses Yelp Api to get the restaurants 

## Getting Started

- In order to get started make sure you have `python3` installed.

- Install `pipenv` to activate the virtual. If you don't have `pipenv` installed follow the [documentation](https://pipenv.readthedocs.io/en/latest/)

- After installing `pipenv` now `cd yelp-cli` and activate the virtual environment using this command `pipenv shell`

- Install dependencies using this command `pipenv install`.

- Now export the api key from Yelp Developers, `export API_KEY=XXXXXXXXXX`

- Lastly now you can run the program `python3 main.py`

## Demo

[![asciicast](https://asciinema.org/a/WwRsRbmfC99XiAw0xPSYGSjz2.svg)](https://asciinema.org/a/WwRsRbmfC99XiAw0xPSYGSjz2)

## Contribution

- If you have any ideas on how to make this better feel free to create a PR.

- Any contribution is welcomed.

Lastly if you have any questions feel free to [Email Me](mailto:muhammadraza0047@gmail.com) and I hope you enjoyed using this simple CLI tool.