Skip to content

pauamargant/AP2-Metro-Nyam

Repository files navigation

Metro Nyam

header image

Search and find restaurants and bars in Barcelona using MetroNyam. Look for restaurants near your location and get to them using the Barcelona subway.

Getting Started

Prerequisites

  • Python is required, version 3.9 or older is recommended.
  • A Telegram account is required to use the bot.

Installation

Clone the repository using git clone https://github.com/pauamargant/AP2-Metro-Nyam and go to the repository directory. Use the package manager pip to install the required packages, which found in the requirements file.

pip install -r requirements.txt

Usage

NyamBot can be used through the Telegram messaging app. Search for @AP2_Nyam_Bot or click the following link.

The bot offers the following commands

  • /start: starts the conversation.
  • /help: shows help about the available commands and options.
  • /options: customize bot options. The following options are available: accessibility.
  • /author: shows info about the authors of the project.
  • /find <query> searchs for restaurants which satisfy the query and shows up to 12 results sorted by distance.
  • /info <number> show additional information about a restaurant, specifying the number which is showed in the results when using /find.
  • /guide <number> show a map and information of the shortest path from your location to the specified restaurant. Use the number which appears next to the restaurant in the last usage of /find <query>. The bot must have received your location.
  • /accessibility toggles the accessibility setting (false by default). If accessibility is enabled the bot will guide you through an accessible plath to the restaurant.
  • /plot_metro Plot in an image the metro network of Barcelona.

Detailed usage

Start the bot by issuing the /start and share your location with the bot.

start |location

Restaurants can be found using /search together with a query. Search queries can be composed of multiples words such as "Pizzeria Sants". The /find command will find restaurants which are a result to all the words in the query. Logical expressions can be used. The supported operators are and, or and not. Queries are in preorder format. An example is /find and(frankfurt,and(Pedralbes,not(Sants))).
Results are ordered by distance to your location.

search |search

The command /info N ()where N is the restaurant number in the search results) allows you to get detailed information about the restaurant.

restaurant konig |restaurant ramen

In order to get a route from your location to the restaurant issue the command /guide N. Accessibility can be toggled in order to get only accessible routes.

ruta 1 |ruta 2

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

License

This project is licensed under the MIT License. The Barcelona Opendata used licensed under its license.

Authors

This project has been created by:

About

Pràctica 2 AP-2

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages