https://github.com/makisukurisu/teledictionary-bot
Telegram bot to get words from various dictionaries.
https://github.com/makisukurisu/teledictionary-bot
chatbot dictionary python-telegram-bot telegram telegram-bot
Last synced: 11 months ago
JSON representation
Telegram bot to get words from various dictionaries.
- Host: GitHub
- URL: https://github.com/makisukurisu/teledictionary-bot
- Owner: makisukurisu
- License: mit
- Created: 2022-02-27T16:04:46.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-03-02T14:26:39.000Z (over 2 years ago)
- Last Synced: 2025-01-31T13:22:08.906Z (over 1 year ago)
- Topics: chatbot, dictionary, python-telegram-bot, telegram, telegram-bot
- Language: Python
- Homepage:
- Size: 50.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# TeleDictionary - Get definitions of words from Telegram
## Description
This bot uses different sources to get definitions of words. Here are the ones planned:
- [ ] [Oxford Dictionary](https://developer.oxforddictionaries.com/)
- [ ] [Urban Dictionary](https://api.urbandictionary.com) (Unofficial API)
- [ ] [Google Gemini (former Bard)](https://ai.google.dev/) (By means of sending a prompt asking for a definition, experimental)
## Usage
This section will be updated later on.
Bot should work in different modes:
- [ ] Inline (primary)
- [ ] Chat (secondary, perhaps for settings and other stuff)
## Installation
This project uses [PDM](https://pdm-project.org/), to install the dependencies, run:
```bash
pdm install
```
## Configuration
To configure the bot, you need to create a `.env` file in the root of the project.
Take a look at [`example.env`](./example.env) for the required environment variables.
## Running
To run the bot, simply run:
```bash
pdm start_bot
```
## Contributing
This project is open to contributions. If you want to contribute, please take a look at the [CONTRIBUTING.md](./CONTRIBUTING.md) file.
Use the [issues](https://github.com/makisukurisu/teledictionary-bot/issues) page to report bugs or suggest new features.
## License
This project is licensed under the [MIT License](./LICENSE).