Project goal

It Is your daily English learning assistance app.

Using cmdenglishassist, you can enter words in Google Translate, and after, you'll be able to generate flashcards in pdf format, get the Anki flashcards, get the words with translations in JSON format, or generate audio in format word+translations.

Here is the repo: https://github.com/obaranovskyi/cmdenglishassist

Installation

curl -s https://raw.githubusercontent.com/obaranovskyi/cmdenglishassist/main/install.sh | bash /dev/stdin

Usage

To use cmdenglishassist:

1. Enter words in google translate and split by colon;
2. Copy the URL;
3. Use it with the current app to generate:
   • json with translations
   • mp3 with translations
   • read markdown in English
   • english flashcards
   • anki flashcards

To generate the json with translations, run:

cmdenglishassist json 'https://translate.google.com/?sl=en&tl=uk&text=1.%20Enter%20words%20in%20google%20translate%20and%20split%20by%20colon%3B%0A2.%20Copy%20URL%20%0A3%20Use%20it%20with%20the%20current%20app%20to%20generate%20the%3A%0A&op=translate'

To generate the mp3 with translations, run:

cmdenglishassist audio 'https://translate.google.com/?sl=en&tl=uk&text=1.%20Enter%20words%20in%20google%20translate%20and%20split%20by%20colon%3B%0A2.%20Copy%20URL%20%0A3%20Use%20it%20with%20the%20current%20app%20to%20generate%20the%3A%0A&op=translate'

To read markdown file content in English:

cmdenglishassist read markdown_with_english_lesson.md

To generate the flashcards in pdf, run:

cmdenglishassist card 'https://translate.google.com/?sl=en&tl=uk&text=1.%20Enter%20words%20in%20google%20translate%20and%20split%20by%20colon%3B%0A2.%20Copy%20URL%20%0A3%20Use%20it%20with%20the%20current%20app%20to%20generate%20the%3A%0A&op=translate'

To generate anki flashcards, run:

cmdenglishassist anki 'https://translate.google.com/?sl=en&tl=uk&text=1.%20Enter%20words%20in%20google%20translate%20and%20split%20by%20colon%3B%0A2.%20Copy%20URL%20%0A3%20Use%20it%20with%20the%20current%20app%20to%20generate%20the%3A%0A&op=translate'

Complex anki questions

The complex questions might be generated from the JSON file.

In question_type.py we have all the types that can be used:

class QuestionType(Enum):
    SIMPLE_QUESTION = 1
    HIDDEN_WORD_IN_SENTENCE = 2
    RANDOM_WORD_SENTENCE = 3

Simple question

JSON example:

{
    "type": 1,
    "questionTitle": "Front header",
    "question": "Question",
    "answerTitle": "Back header",
    "answer": "Answer"
}

Sentence with hidden words

JSON example:

{
    "type": 2,
    "questionTitle": "Present perfect continuous. Fill in the missing words.",
    "answerTitle": "The right answer is:",
    "src": "I{0} this TV show {1}.",
    "answers": ["'ve been watching", "lately"],
    "questions": ["____ (watch)", "___"]
}

Sentence with wrong word order

JSON example:

{
    "type": 3,
    "questionTitle": "Arrange words.",
    "answerTitle": "The right answer is:",
    "src": "Who is it?"
}

Yaml format alternative

It's important to note that instead of JSON can be used Yaml format as an alternative.

The previous JSON can be translated to Yaml in the following way:

- type: 1
  questionTitle: Front header
  question: Question
  answerTitle: Back header
  answer: Answer
- type: 2
  questionTitle: Present perfect continuous. Fill in the missing words.
  answerTitle: 'The right answer is:'
  src: I{0} this TV show {1}.
  answers: 
    - "'ve been watching"
    - lately
  questions:
    - ____ (watch)
    - ___
- type: 3
  questionTitle: Arrange words.
  answerTitle: 'The right answer is:'
  src: Who is it?

Markdown format alternative

Probably the most straightforward way to write questions is the markdown format. Here is an example of how to do it:

---

# (QS):
Here will be the question

# (AS):
Here will be the answer

<div class="hi">Note: This is test</div>

---

# (QS):
Here will be the second question

# (AS):
Here will be the second answer

---

Uninstall

To uninstall run the following script

curl -s https://raw.githubusercontent.com/obaranovskyi/cmdenglishassist/main/uninstall.sh | bash /dev/stdin