Skip to main content

What to eat? CLI tool to interaction with Wolt API

Project description

๐Ÿ” What to eat? ๐Ÿ•

CLI tool to query Wolt API in your location!

Release Build Status PyPI Code style: black

Why to use what-to-eat? How many times have you not known what to order for dinner or lunch? What-to-eat will help you querying and filtering restaurants available in your location via Wolt app! ๐Ÿ”

Example usage:

demo

โœจ Features

  • ๐Ÿ” Query restaurants in your location
  • ๐Ÿ• Filter restaurants by name, cuisine, price, rating, delivery time, etc.
  • ๐Ÿ— Display restaurant details
  • ๐ŸŸ Random restaurant draw

๐Ÿ› ๏ธ Installation

What to eat is compatible with Python 3.10+ and runs on Linux, macOS and Windows. The latest releases with binary wheels are available from pip. Before you install What to eat and its dependencies, make sure that your pip, setuptools and wheel are up to date.

You can install what-to-eat using pip:

pip install what-to-eat

๐Ÿ’ฌ Available commands

There are currently 3 commands available, one of which is used to configure the tool: configure, ls, random:

$ what-to-eat --help

 Usage: what-to-eat [OPTIONS] COMMAND [ARGS]...

โ•ญโ”€ Options โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ --version             -v                                                                                                    โ”‚
โ”‚ --install-completion            Install completion for the current shell.                                                   โ”‚
โ”‚ --show-completion               Show completion for the current shell, to copy it or customize the installation.            โ”‚
โ”‚ --help                          Show this message and exit.                                                                 โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
โ•ญโ”€ Commands โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ configure                                Create configuration file to your orders                                           โ”‚
โ”‚ ls                                       List restaurants queried from Wolt API.                                            โ”‚
โ”‚ random                                   Finds random restaurant via Wolt API                                               โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ

You can find examples of using these commands in the section below.

โœจ Examples

Configure your tool:
$ what-to-eat configure

List all available restaurants in your localization:

$ what-to-eat ls

Sort restaurants by rating and limit results to 5 records:

$ what-to-eat ls --sort rating --ordering desc --limit 5
โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ No. โ”ƒ                               Restaurant โ”ƒ                  Address โ”ƒ Estimate time โ”ƒ Delivery cost โ”ƒ Rating โ”ƒ Price โ”ƒ                Tags โ”ƒ
โ”กโ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ 1   โ”‚               Mikropiekarnia Pochlebstwo โ”‚       Romanowicza 5/LU7b โ”‚   25 - 35 min โ”‚ (No delivery) โ”‚   10.0 โ”‚  ๐Ÿ’ฐ๐Ÿ’ฐ โ”‚     Bakery, Grocery โ”‚
โ”‚ 2   โ”‚                            KruKam Krakรณw โ”‚        ul. Krakowska 35A โ”‚   30 - 40 min โ”‚ (No delivery) โ”‚    9.8 โ”‚  ๐Ÿ’ฐ๐Ÿ’ฐ โ”‚    Grocery, Healthy โ”‚
โ”‚ 3   โ”‚                    Piekarnia Mojego Taty โ”‚           ul. Meiselsa 6 โ”‚   20 - 30 min โ”‚ (No delivery) โ”‚    9.8 โ”‚    ๐Ÿ’ฐ โ”‚     Bakery, Grocery โ”‚
โ”‚ 4   โ”‚  MARLIN - Fish & Chips - Smaลผalnie Rybne โ”‚ Krowoderskich Zuchรณw 21A โ”‚   45 - 55 min โ”‚ (No delivery) โ”‚    9.6 โ”‚  ๐Ÿ’ฐ๐Ÿ’ฐ โ”‚ Fish, Mediterranean โ”‚
โ”‚ 5   โ”‚ Lody Ice Cream NOW - Stare Miasto II (K) โ”‚  This is a virtual venue โ”‚   20 - 30 min โ”‚ (No delivery) โ”‚    9.6 โ”‚  ๐Ÿ’ฐ๐Ÿ’ฐ โ”‚           Ice cream โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                                                        ๐Ÿฟ Restaurants in Krakรณw via wolt ๐Ÿฟ

While using ls command you can also use option query to filter results by restaurant name, address or tags:

$ what-to-eat ls --query Pizza --limit 3
โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ No. โ”ƒ                          Restaurant โ”ƒ           Address โ”ƒ Estimate time โ”ƒ Delivery cost โ”ƒ Rating โ”ƒ Price โ”ƒ                  Tags โ”ƒ
โ”กโ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚ 1   โ”‚ Pizzeria Caprese Chillzone Mล‚ynรณwka โ”‚    Racล‚awicka 21, โ”‚   20 - 30 min โ”‚ (No delivery) โ”‚    8.4 โ”‚  ๐Ÿ’ฐ๐Ÿ’ฐ โ”‚        Italian, pizza โ”‚
โ”‚ 2   โ”‚                            U Filipa โ”‚ Ul. ลšw. Filipa 25 โ”‚   30 - 40 min โ”‚ (No delivery) โ”‚    7.8 โ”‚    ๐Ÿ’ฐ โ”‚                 pizza โ”‚
โ”‚ 3   โ”‚                  Baqaro - Rakowicka โ”‚      Rakowicka 11 โ”‚   25 - 35 min โ”‚ (No delivery) โ”‚      - โ”‚  ๐Ÿ’ฐ๐Ÿ’ฐ โ”‚ Italian, Pinsa, pizza โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜
                                                   ๐Ÿฟ Restaurants in Krakรณw via wolt ๐Ÿฟ

By default your first profile is default one. But while listing restaurants you can change it using profile option:

$ what-to-eat ls --profile work

You can also display restaurant details by using ls command with restaurant name:

$ what-to-eat ls zapiecek
โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ณโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”“
โ”ƒ     ๐Ÿ• Zapiecek โ”ƒ                       Krakรณw, Ul. Floriaล„ska 20 ๐Ÿ• โ”ƒ
โ”กโ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ•‡โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”โ”ฉ
โ”‚          Rating โ”‚                           Amazing (9 / 20 reviews) โ”‚
โ”‚           Price โ”‚                                                 ๐Ÿ’ฐ โ”‚
โ”‚    Opening time โ”‚                                      10:00 - 20:45 โ”‚
โ”‚         Website โ”‚ https://wolt.com/pl/pol/krakow/restaurant/zapiecek โ”‚
โ”‚           Phone โ”‚                                      +48 124221345 โ”‚
โ”‚       Estimates โ”‚                                         30 minutes โ”‚
โ”‚ Payment Methods โ”‚                                               Card โ”‚
โ”‚     Description โ”‚               Kultowy bar kanapkowo - saล‚atkowy... โ”‚
โ”‚            Tags โ”‚                                    Sandwich, Salad โ”‚
โ””โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”˜

However, perhaps the coolest options is to randomly select restaurants.

$ what-to-eat random

Note: The selection algorithm is based on the ranking and delivery time for a given restaurant.

You can also enter a tag based on which a restaurant will be randomly selected:

$ what-to-eat random --tag pizza

Random command supports technique option, which allows you to choose the algorithm used to select a restaurant. The default value is mix and it means that the restaurant will be selected based on the ranking and delivery time.

$ what-to-eat random --technique mix

You can select one of the following techniques:

  • mix - the restaurant will be selected based on the ranking and delivery time.
  • rating - the restaurant will be selected based on the ranking.
  • delivery_time - the restaurant will be selected based on the delivery time.
  • random - the restaurant will be selected randomly.

๐Ÿ“– Documentation

Documentation Command Options
๐Ÿš€ List all restaurants what-to-eat ls query, profile, tag, sort, ordering, limit
๐ŸŽฒ Random restaurant what-to-eat random profile, tag, technique
๐Ÿ‘ค Configure profile what-to-eat config

๐Ÿ“š License

This project is licensed under the terms of the MIT license.

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

what_to_eat-1.1.0.tar.gz (36.5 kB view details)

Uploaded Source

Built Distribution

what_to_eat-1.1.0-py3-none-any.whl (18.9 kB view details)

Uploaded Python 3

File details

Details for the file what_to_eat-1.1.0.tar.gz.

File metadata

  • Download URL: what_to_eat-1.1.0.tar.gz
  • Upload date:
  • Size: 36.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.5 Darwin/22.6.0

File hashes

Hashes for what_to_eat-1.1.0.tar.gz
Algorithm Hash digest
SHA256 ee947ab3cd680df298a4910e5bff448fea5e6a3787e7405e7f174afc43cb3f3e
MD5 fe0570365e8ac84c936b64b5786fa108
BLAKE2b-256 3fd040fe32c8c714bd5ed71b4e50252438555e18cbb324c8bcfea9b72f0a3db3

See more details on using hashes here.

File details

Details for the file what_to_eat-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: what_to_eat-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 18.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.11.5 Darwin/22.6.0

File hashes

Hashes for what_to_eat-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 94ed665c4cf8f817e9d214e88cf32bbf1ca69e26ddc97843aec0937966b8b1d6
MD5 d5af111b95c1377bcf5cb754e1ecc535
BLAKE2b-256 d8e38d995eeef1b3597e8538939432402fb06c41082b148fe22f9b89b7b5e082

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