Skip to main content

Pylunch cli and web tool to get lunch info

Project description

Pylunch

PyLunch was designed to scrape restaurants for it's daily menus and show them in multiple ways and formats.

Getting stated

PyLunch is a scraper, to use it, you have to install it. It is available at PyLunch

Install the released version

You can install the PyLunch using the pip:

$ pip install pylunch

Install the development version from github

  • Python 3.7 or later
  • (Optional) pipenv

Or you can add it as a development dependency using the pipenv

$ git clone https://github.com/pestanko/pylunch.git
$ cd pylunch
$ pipenv install # install the dependencies

Install Tesseract for OCR support

To support extracting text from images you need to install Tesseract. Then you need to download trained models for your language Tesseract data files wiki (English is supported by default).

Recommended are the best (most accurate) trained models. Save downloaded trained models to a dictionary with name tessdata. Expose environment variable TESSDATA_PREFIX with path to tessdata directory (i.e. TESSDATA_PREFIX=/tmp/tessdata).

You can specify different language when extracting data from the image for any restaurant with attribute language: <Lang code> in restaurants.yml file.

Dockerfile supported languages:

Language Lang code
English eng
Czech ces
Slovak slk

First Run

In order to run the tool correctly you need to configure it.

At first run the tool will create config folder in the home directory with restaurants database, by default it will be empty.

To use the zomato resolver you need to add the zomato_key to your configuration. In order to get the zomato key you need to go to the Zomato Api documentation

$ pylunch cfg-set zomato_key "<YOUR_KEY>"

To use the telegram integration, you need to set the telegram bot token property telegram_token. To get the telegram bot token please take a look here.

$ pylunch cfg-set telegram_token "<YOUR_KEY>"

Also if you have already created or exported database of the restaurants, you an import it using the command import: Example file is located in: resources/restaurants.yml available here.

$ pylunch import -O restaurants.yml

If you wish to load example from the repository you can use the curl and just pipe it to the import subcommand.

$ curl 'https://gitlab.com/pestanko/pylunch/raw/master/resources/restaurants.yml' | pylunch import -O 

In order to export the restaurants database file, you can use the export command.

$ pylunch export -f exported.yml

Run the cli tool

Hera is a help output with available commands.

# Show the help
$ pylunch --help

Usage: pylunch [OPTIONS] COMMAND [ARGS]...

  PyLunch CLI tool

Options:
  --version              Show the version and exit.
  -L, --log-level TEXT   Set log level (d|i|w|e) - default=w
  -C, --no-cache         Disable cache
  -c, --config-dir TEXT  Location to the configuration directory
  -F, --format TEXT      Set output format
  --help                 Show this message and exit.

Commands:
  add            Adds a new restaurant
  cache-clear    Clear a current cache for a day
  cache-content  Show the current cache for a day
  cfg-edit       Edit a configuration using the editor (Ex: VIM)
  cfg-set        Set a config value in the user configuration
  config         Shows the current configuration
  console        Start the interactive console (IPython)
  disable        Disables the restaurants
  edit           Edits restaurants DB file
  enable         Enables the restaurants
  export         Export restaurants
  import         Import restaurants
  info           Get info for the restaurant
  ls             List all available restaurants
  menu           Get menu for a restaurant
  rm             Removes the restaurant
  telegram-bot   Start the telegram bot

Runnig the server

As a server is used the Flask. To run the flask server please take a look to the documnetation.

In order to start the pylunch server take a look at the run_flask.ps1 or run_flask.sh scripts.

For access to the admin pages - in order to import restaurants or invalidate (refresh cache) you will need to set env variables:

PYLUNCH_SECRET=<JWT_SECRET>
PYLUNCH_USERS=PATH_TO_USERS_FILE

Admin user credentials:

Username: admin
Password: foobar1

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pylunch, version 0.2.7
Filename, size File type Python version Upload date Hashes
Filename, size pylunch-0.2.7-py3-none-any.whl (39.7 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size pylunch-0.2.7.tar.gz (34.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page