jay-joshy / question_cli

0 stars 0 forks source link

README

Purpose

Quick internal command line tool to both classify and/or answer questions.

Requirements

You require a .json file with questions formatted as such:

[
  {
    "question": "Infection with X drug makes you more likely to have infection from the following?",
    "options": [
      "Histoplasma",
      "Escherichia coli",
      "Listeria monocytogenes",
      "HIV",
      "Streptococcus spp."
    ],
    "answer": "HIV"
  },
  {
    "question": "A 43-year-old woman ...  Which one of the following tests is most likely to be diagnostic in this case?",
    "options": [
      "CXR",
      "CBC",
      "ALT",
      "CT Chest",
      "ANA"
    ],
    "answer": "ANA"
  }
]

How to use

Open your command line and run the tool using the format below. For Windows, this is the "Command Prompt" or "PowerShell" app; for MacOS/Linux it is the "Terminal".

question_cli <classify or answer> <path_to_json>

Example:

question_cli answer /home/josh/Documents/question_cli/questions.json

Once running the tool, instructions are provided on how to navigate through each question. A progress bar is at the bottom of the screen to indicate how many questions are left to classify/answer. If text is looking like its being cut off, please either increase the size of the terminal or reduce the text size (ie. Ctrl-).

Enjoy!