Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/laurencewarne/curses-questions

Test yourself without leaving your terminal
https://github.com/laurencewarne/curses-questions

anki bash curses linux python3 terminal

Last synced: about 1 month ago
JSON representation

Test yourself without leaving your terminal

Awesome Lists containing this project

README 

        
# Curses Questions



A simple script which uses curses to create a nice TUI for asking questions.



Table of Contents

=================



   * [Curses Questions](#curses-questions)

      * [Demo](#demo)

      * [Installation](#installation)

      * [Usage](#usage)

      * [Anki .apkg Compatibility](#anki-apkg-compatibility)

      * [Recipes](#recipes)



## Demo



[![asciicast](https://asciinema.org/a/VM1Gx7rwbmdSP1vFbd5HecPtx.svg)](https://asciinema.org/a/VM1Gx7rwbmdSP1vFbd5HecPtx)



## Installation



Requires python 3.



```

# Installs locally

$ pip3 install curses-questions --user

```



Or install from source:



```

$ git clone https://github.com/LaurenceWarne/curses-questions.git && cd curses-questions

# Installs locally

$ python3 setup.py install --user

```



## Usage



```

usage: curses-questions [-h] [-d DELIMITER] [-p PRECEDE] [-c CHOICES | -pa] -n

                        QUESTIONS | -a | -e]

                        [infile]



Answer questions from a text file using the number keys. Questions and their

answers should be on the same line and split by a common delimeter. The answer

choices displayed by the program for a given question are sampled randomly

from other questions in the input file (in addition to the correct answer).



positional arguments:

  infile                name of file to read questions from, defaults to stdin



optional arguments:

  -h, --help            show this help message and exit

  -d DELIMITER, --delimiter DELIMITER

                        delimiter in input lines which divide the question and

                        answer, default is tab

  -p PRECEDE, --precede PRECEDE

                        precede all question strings with this string

  -c CHOICES, --choices CHOICES

                        number of answers to choose from per question, default

                        is 3

  -pa, --preset-answers

                        using this option will replace the programs default

                        behaviour of obtaining possible answers for a question

                        by sampling answers to other questions. Instead, the

                        program will interpret input lines as a question

                        followed by one or more answers; the question/answers

                        being seperated by the --delimiter option and the

                        question always being taken as the string before the

                        first occurrence of the delimiter. The correct answer

                        will be taken as the string after.

  -n QUESTIONS, --questions QUESTIONS

                        number of questions to answer (no duplicates). If this

                        is greater than the number of questions in the file,

                        all the questions are asked in a random order.

  -a, --all             Ask all questions in the input file, preserving their

                        order

  -e, --endless         keep asking questions until user terminates program

```



## Anki .apkg Compatibility



You can use the ```curses-anki``` script to convert anki .apkg files to a format usable by ```curses-questions```:

```

$ curses-anki my-file.apkg --fields 1 3 | curses-questions

```

Here the ```--fields``` flag corresponds to text separated by the character ```\x1f``` in the ```flds``` column of the ```notes``` table in the database extracted from the .apkg file (you can read more about the .apkg file format [here](https://decks.fandom.com/wiki/Anki_APKG_format_documentation)). ie the values of 1 3 above with the flds column ```hi\x1fthere\x1fsir``` will return ```hi``` and ```sir```.



The fields typically correspond to rows specified in a deck intro. Taking as a working example [this](https://ankiweb.net/shared/info/685421036) deck on works of art, the command:

```

$ curses-anki Great_Works_of_Art.apkg -f 2 3

```

Will print ```AUTHOR        PAINTING```(tab separated) for each note. and the command:

```

$ curses-anki Great_Works_of_Art.apkg -f 3 6

```

Will print ```PAINTING        PERIOD``` for each note.



Without the ```--fields``` option the script will guess appropriate fields by looking at their content.



Note using this script will create a ```collection.anki2``` file in your working directory.



## Recipes



Test yourself on elements and their symbols:

```

$ wget https://raw.githubusercontent.com/andrejewski/periodic-table/master/data.csv -O elements.csv && cut -d "," -f 2,3 elements.csv | curses-questions -d "," -e -c 5

```



American presidents and years they were in office:

```

$ wget https://raw.githubusercontent.com/m0rt1m3r/US-Presidents/master/USPresidents.csv && cut -d "," -f 2,4 USPresidents.csv | curses-questions -d "," -c 5 -p "Which of these dates marks the starting term of "



```