https://github.com/kulmajaba/word-bot

Telegram bot for word-related queries
https://github.com/kulmajaba/word-bot

telegram telegram-bot

Last synced: about 1 year ago
JSON representation

Telegram bot for word-related queries

• Host: GitHub
• URL: https://github.com/kulmajaba/word-bot
• Owner: kulmajaba
• License: mit
• Created: 2021-09-23T12:11:53.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2021-09-23T12:12:15.000Z (almost 5 years ago)
• Last Synced: 2025-02-15T20:41:26.353Z (over 1 year ago)
• Topics: telegram, telegram-bot
• Language: Python
• Homepage:
• Size: 40 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Wordbot

Telegram-bot for words around a specific topic.

## Setup

To parse dictionary words, download kotus-sanalista_v1 and run `WORD=asd python db/parse-kotus.py` from the project root. This will create the file `init_words.sql` which is required to initialize the DB.

The backend is built using Docker and docker-compose, but should be possible to run without Docker as well. The implementation is done with Python 3.8.5 using PostgreSQL 12

Copy or rename the `.env.sample` file to the same folder as `.env` and fill in the missing information.

| Variable          | Description |

| ----------------- | ----------- |

| TG_TOKEN          | Telegram API token for the bot. |

| LOCALE            | Language, e.q. `fi`. Ensure the locale translations exist in `strings.py`. |

| WORD              | The substring to search for. |

| PGTZ              | Postgres default timezone. |

| POSTGRES_DB       | Postgres database name. Used by both PostgreSQL and Python code. |

| POSTGRES_USER     | Postgres user for DB access. Same as above. |

| POSTGRES_PASSWORD | Postgres user password. Same as above. |

| POSTGRES_HOST     | Hostname for the Python code to use when connecting to the DB, use `db` for Docker installations with the default docker-compose file |

| POSTGRES_PORT     | Postgres port, used by both PostgreSQL and Python code. |

| POSTGRES_TABLE_WORD | Table name for the words, use `word` for installations with the default database initialization |

| POSTGRES_TABLE_WORD_QUERY | Table name for word query counts, use `word_query` for installations with the default database initialization |

After that, you should be able to build and run the bot with `docker-compose up -d`. Add `--build` to rebuild images and/or `--force-recreate` to recreate the application containers.

Check logs with `docker-compose logs`, `-f` to follow, shut down with `docker-compose down`.