]> git.armaanb.net Git - lightcards.git/blob - lightcards/lightcards.py
Comment and clean code
[lightcards.git] / lightcards / lightcards.py
1 # Markdown flashcard utility
2 # Armaan Bhojwani 2021
3
4 import argparse
5 from curses import wrapper
6 import os
7 from random import shuffle
8 import sys
9
10 from . import parse, progress
11 from .display import Display
12 from .deck import Status
13
14
15 def parse_args():
16     parser = argparse.ArgumentParser(
17         description="Terminal flashcards from Markdown")
18     parser.add_argument("inp",
19                         metavar="input file",
20                         type=str,
21                         nargs=1)
22     parser.add_argument("-a", "--alphabetize",
23                         action='store_true',
24                         help="alphabetize card order")
25     parser.add_argument("-f", "--flip",
26                         action='store_true',
27                         help="show second column first")
28     parser.add_argument("-p", "--purge",
29                         action='store_true',
30                         help="don't check cached info before starting")
31     # TODO: don't require input file when using  -P
32     parser.add_argument("-P", "--purge-all",
33                         action='store_true',
34                         help="don't check cached info before starting")
35     parser.add_argument("-r", "--reverse",
36                         action='store_true',
37                         help="reverse card order")
38     parser.add_argument("-s", "--shuffle",
39                         action='store_true',
40                         help="shuffle card order")
41     parser.add_argument("-v", "--version",
42                         action='version',
43                         version="lightcards 0.4.0")
44     return parser.parse_args()
45
46
47 def show(args, stack, headers):
48     """
49     Get objects from cache, manipulate deck according to passed arguments, and
50     send it to the display functions
51     """
52     # Purge caches if asked
53     if args.purge:
54         progress.purge(stack)
55     if args.purge_all:
56         progress.purge_all()
57
58     # Check for caches
59     idx = Status()
60     cache = progress.dive(get_orig())
61     if cache:
62         (stack) = cache
63
64     # Manipulate deck
65     if args.shuffle:
66         shuffle(stack)
67     if args.alphabetize:
68         stack.sort()
69     if args.reverse:
70         stack.reverse()
71     if args.flip:
72         for x in stack:
73             x[0], x[1] = x[1], x[0]
74         headers[0], headers[1] = headers[1], headers[0]
75
76     # Send to display
77     win = Display(stack, headers, idx)
78     wrapper(win.run)
79
80
81 def reparse():
82     """Parse arguments and input file again"""
83     args = parse_args()
84     os.system(f"$EDITOR {args.inp[0]}"),
85     return parse.parse_html(parse.md2html(args.inp[0]))
86
87
88 def get_orig():
89     """Return original header and stack"""
90     return((headers, stack))
91
92
93 def main(args=sys.argv):
94     args = parse_args()
95     global headers, stack
96     (headers, stack) = parse.parse_html(parse.md2html(args.inp[0]))
97     show(args, stack, headers)
98
99
100 if __name__ == "__main__":
101     main()