https://github.com/pybites-open-source/italki-class-assistant
https://github.com/pybites-open-source/italki-class-assistant
hacktoberfest italki
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/pybites-open-source/italki-class-assistant
- Owner: PyBites-Open-Source
- Created: 2023-08-15T16:49:43.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-09-18T08:50:46.000Z (over 2 years ago)
- Last Synced: 2025-04-24T00:02:29.809Z (10 months ago)
- Topics: hacktoberfest, italki
- Language: Python
- Homepage:
- Size: 28.3 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Italki Class Assistant
This script / repo is to quickly look up words in different target languages as I am talking with my teachers on Italki 💪
It uses [Googletrans](https://py-googletrans.readthedocs.io/en/latest/) but note that due to [an issue](https://github.com/ssut/py-googletrans/issues/383) it uses [a pre-release](https://pypi.org/project/googletrans/3.1.0a0/)
## Installation
1. Create Virtual Environment
```bash
$ python3 -m venv venv
```
2. Activate Environment
```bash
$ source venv/bin/activate # Mac/Linux
$ venv\Scripts\activate # Windows
```
3. Install Dependencies
```bash
$ pip install -r requirements.txt
```
4. Setup Database
```bash
$ python3 db.py
```
5. (Optional) Copy `.env-template`
```bash
$ cp .env-template .env
```
`.env` file should now exist.
6. (Optional) Configure Default Language in `.env`
If you want to start the app with a pre-selected language, you can set the `ITALKI_ACTIVATE_LANGUAGE_CODE` environment variable in the `.env` file.
EXAMPLE:
```js
ITALKI_ACTIVATE_LANGUAGE_CODE="fr"
```
## Running
1. Running GUI (Graphical User Interface)
```bash
$ python3 gui.py
```
2. Running CLI (Cammand Line Interface)
```
$ python3 main.py
```
Enjoy 😎 and boost your language learning 📈
