Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/skelly37/pyfram-telegram-bot

Open-source WolframAlpha Telegram bot
https://github.com/skelly37/pyfram-telegram-bot

bot mathematics maths python-bot telebot telegram telegram-bot telegram-bot-api wolfram-alpha

Last synced: 5 days ago
JSON representation

Open-source WolframAlpha Telegram bot

Host: GitHub
URL: https://github.com/skelly37/pyfram-telegram-bot
Owner: skelly37
License: mit
Created: 2022-02-05T11:32:56.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2022-04-28T09:57:14.000Z (almost 3 years ago)
Last Synced: 2024-11-27T14:18:42.592Z (2 months ago)
Topics: bot, mathematics, maths, python-bot, telebot, telegram, telegram-bot, telegram-bot-api, wolfram-alpha
Language: Python
Homepage:
Size: 8.76 MB
Stars: 3
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # pyfram-telegram-bot

Open-source [WolframAlpha](https://wolframalpha.com) Telegram bot

- Telegram API wrapper: [telebot](https://github.com/eternnoir/pyTelegramBotAPI)

- Deployed on: [Heroku](https://heorku.com)

- Static type checking: [mypy](https://mypy.readthedocs.io/en/stable/getting_started.html)

  - `mypy pyfram_bot.py api_calls.py` ->  **Success: no issues found in 2 source files**

- Unit tests: [test_bot.py](test_bot.py)

  - Sometimes you'll have to run tests twice (or even thrice). It's rather a problem with the API and time needed to process the request for step-by-step image.

## Current status:

The bot works pretty fine for the end-user, all the functionality I wanted to introduce is already there. Only the code [needs some polishing](#todo)

## What can the end-user achieve with bot? How to use it?

- `/s` or `/steps` command before actual query — get step-by-step solution (if possible).

  - **NOTE** This may take quite a long time but it's not a problem with my code, it's WolframAlpha API issue. 

- `/i` or `/image` command before actual query — force get result as an image.

- `/start` or `/help` commands — provide basic help.

- If no commands are provided, the bot has these defaults:

  - Try getting and sending short text answer

  - If the short answer is not available, return image (as in `/image`)

- Inline mode works only for simple answers:

  - If available, prompt will display your question, the result will be the answer

  - If unavailable, both prompt and result will be "No short answer available"

## Video preview:

![Bot functionality preview](preview/wolframbot.gif "Bot functionality preview")

## How the code works?

Well, it's no dark magic. I simply query WolframAlpha API and send text answer or image:

  - get user input via telebot

  - `requests.get()`

  - then send the result via telebot

The short import lists are also self-explanatory. As you can see in [TODO](#todo), in free time I'll also introduce type checking. Bot is ready to go to Heroku, code is clear and understandable (at least I hope so).

## Why won't we develop a public bot?

Wolfram API for a non-personal use is quite expensive and we cannot afford being *Santa Claus*. That's why we provide only the code and left the `appID` empty. Feel free to set up such a bot for personal use with your own API key or to gain funds for a fully public one.

But if you want to see the bot in action: @wolaph_bot

## [api_calls.py](https://github.com/skelly37/pyfram-telegram-bot/blob/main/api_calls.py) simple documentation

The whole API wrapper is developed in `WolframBot` class. 

- Attributes:

  - `__app_ids` (list) — list of app_ids to use with the `WolframBot`  

  - `__num_of_appids` (int) — how many app IDs are provided?

- Methods:

  - `__init__`

    - Arguments:

      - `app_ids` (list) — list of app_ids to use with the `WolframBot`

    - Returns:

      - None    

  - `__get_random_id`

    - Arguments:

      - None

    - Returns:

      - Randomly chosen app ID from `self.__app_ids` (str)

  - `__short_answer`

    - Arguments:

      - `query` (str) — question to ask WolframAlpha

    - Returns:

      - Result of querying WolframAlpha. May return "No short answer available" (str)

  - `__get_image`

    - Arguments:

      - `query` (str) — question to ask WolframAlpha

    - Returns:

      - Name of the file where result is stored. May return "Error processing your request." (str)

  - `__get_url_of_steps_image`

    - Arguments:

      - `img_xml` (str) — raw query result.

    - Returns:

      - Desired url from XML. May return "No step by step solution available." (str)

  - `get_step_by_step`

    - Arguments:

      - `query` (str) — question to ask WolframAlpha

    - Returns:

      - Name of the file where result is stored. May return "Error processing your request." or "No step by step solution available." (str)

  - `query_wolfram`

    - Arguments:

      - `query` (str) — question to ask WolframAlpha

      - `is_image` (bool, optional) — if True, the method will skip trying to get short answer and proceed to fetching image in the first place

      - `inline_mode` (bool, optional) — if True, the method will skip trying to get image answer and will send any result of fetching simple answer. 

    - Returns:

      - Short answer, filename, may also return "Error processing your request." or "No step by step solution available." (str)

## Contribution

Feel free to create issues, to make PRs, every kind of help is welcome here

You can reach me and talk about this project on:

- Telegram (preferred): @skelly37

- Discord: skelly#3578

## License

The code is and will be distributed under the permissive [MIT License](https://github.com/skelly37/pyfram-telegram-bot/blob/main/LICENSE)