randex 0.3.1__tar.gz → 0.3.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: randex
3
- Version: 0.3.1
3
+ Version: 0.3.2
4
4
  Summary: Create randomized multiple choice exams using latex.
5
5
  License: CC BY-NC 4.0
6
6
  Author: G. Arampatzis
@@ -70,57 +70,56 @@ probably have already `latexmk` installed as well.
70
70
 
71
71
  ## Randex Commands
72
72
 
73
- ### randex-download-examples
73
+ ### randex download-examples
74
74
 
75
- To download the latest examples from GitHub, run the following command from the root
76
- folder of the project:
75
+ To download the latest examples from GitHub, run the following command:
77
76
 
78
77
  ```sh
79
- randex-download-examples
78
+ randex download-examples
80
79
  ```
81
80
 
82
- ### validate
81
+ ### randex validate
83
82
 
84
83
  This command validates a single question or all questions under a folder. Execute:
85
84
 
86
85
  ```sh
87
- validate -t examples/en/template-exam.yaml -o tmp --overwrite "examples/en/folder_*"
86
+ randex validate "examples/en/folder_*" -t examples/en/template-exam.yaml -o tmp --overwrite
88
87
  ```
89
88
 
90
89
  to validate all the questions under the folder `examples/en` that contains subfolders
91
90
  with questions.
92
91
  It will use the configuration from the file `examples/en/template-exam.yaml`.
93
- The LaTeX compilation will run inside the `temp` folder.
92
+ The LaTeX compilation will run inside the `tmp` folder.
94
93
  The `--clean` option will remove all intermediate files created by LaTeX,
95
94
  and the `-a` flag will show the correct answers in the produced PDF.
96
- Open the PDF file inside `temp` to validate that all questions appear correctly.
95
+ Open the PDF file inside `tmp` to validate that all questions appear correctly.
97
96
 
98
97
  Run:
99
98
 
100
99
  ```sh
101
- validate --help
100
+ randex validate --help
102
101
  ```
103
102
 
104
103
  to see the help message for the command.
105
104
 
106
- ### exams
105
+ ### randex batch
107
106
 
108
107
  To create a batch of exams with random questions, execute:
109
108
 
110
109
  ```sh
111
- exams -b 5 -n 2 -t examples/en/template-exam.yaml -o tmp --overwrite --clean "examples/en/folder_*"
110
+ randex batch "examples/en/folder_*" 5 -n 2 -t examples/en/template-exam.yaml -o tmp --overwrite --clean
112
111
  ```
113
112
 
114
- This command will create 5 exams from using the questions inside the 3 folders with
113
+ This command will create 5 exams using the questions inside the 3 folders with
115
114
  names `folder_0`, `folder_1`, and `folder_2` using the configuration from the file
116
115
  `examples/en/template-exam.yaml`.
117
116
  The `--clean` option will remove all intermediate files created by LaTeX.
118
117
  The `-n` option specifies the number of questions randomly chosen from each folder.
119
118
  It can appear once, meaning all folders will contribute the same number of questions,
120
- or multiple times, e.g., `-n 2 -n 1 -n 3 `, indicating the first folder will contribute
119
+ or multiple times, e.g., `-n 2 -n 1 -n 3`, indicating the first folder will contribute
121
120
  2 questions, the second folder will contribute 1 question, and the third folder will
122
121
  contribute 3 questions.
123
- The `-b` option specifies the number of exams to create.
122
+ The batch size (5 in this example) specifies the number of exams to create.
124
123
 
125
124
  ### Grade
126
125
 
@@ -44,57 +44,56 @@ probably have already `latexmk` installed as well.
44
44
 
45
45
  ## Randex Commands
46
46
 
47
- ### randex-download-examples
47
+ ### randex download-examples
48
48
 
49
- To download the latest examples from GitHub, run the following command from the root
50
- folder of the project:
49
+ To download the latest examples from GitHub, run the following command:
51
50
 
52
51
  ```sh
53
- randex-download-examples
52
+ randex download-examples
54
53
  ```
55
54
 
56
- ### validate
55
+ ### randex validate
57
56
 
58
57
  This command validates a single question or all questions under a folder. Execute:
59
58
 
60
59
  ```sh
61
- validate -t examples/en/template-exam.yaml -o tmp --overwrite "examples/en/folder_*"
60
+ randex validate "examples/en/folder_*" -t examples/en/template-exam.yaml -o tmp --overwrite
62
61
  ```
63
62
 
64
63
  to validate all the questions under the folder `examples/en` that contains subfolders
65
64
  with questions.
66
65
  It will use the configuration from the file `examples/en/template-exam.yaml`.
67
- The LaTeX compilation will run inside the `temp` folder.
66
+ The LaTeX compilation will run inside the `tmp` folder.
68
67
  The `--clean` option will remove all intermediate files created by LaTeX,
69
68
  and the `-a` flag will show the correct answers in the produced PDF.
70
- Open the PDF file inside `temp` to validate that all questions appear correctly.
69
+ Open the PDF file inside `tmp` to validate that all questions appear correctly.
71
70
 
72
71
  Run:
73
72
 
74
73
  ```sh
75
- validate --help
74
+ randex validate --help
76
75
  ```
77
76
 
78
77
  to see the help message for the command.
79
78
 
80
- ### exams
79
+ ### randex batch
81
80
 
82
81
  To create a batch of exams with random questions, execute:
83
82
 
84
83
  ```sh
85
- exams -b 5 -n 2 -t examples/en/template-exam.yaml -o tmp --overwrite --clean "examples/en/folder_*"
84
+ randex batch "examples/en/folder_*" 5 -n 2 -t examples/en/template-exam.yaml -o tmp --overwrite --clean
86
85
  ```
87
86
 
88
- This command will create 5 exams from using the questions inside the 3 folders with
87
+ This command will create 5 exams using the questions inside the 3 folders with
89
88
  names `folder_0`, `folder_1`, and `folder_2` using the configuration from the file
90
89
  `examples/en/template-exam.yaml`.
91
90
  The `--clean` option will remove all intermediate files created by LaTeX.
92
91
  The `-n` option specifies the number of questions randomly chosen from each folder.
93
92
  It can appear once, meaning all folders will contribute the same number of questions,
94
- or multiple times, e.g., `-n 2 -n 1 -n 3 `, indicating the first folder will contribute
93
+ or multiple times, e.g., `-n 2 -n 1 -n 3`, indicating the first folder will contribute
95
94
  2 questions, the second folder will contribute 1 question, and the third folder will
96
95
  contribute 3 questions.
97
- The `-b` option specifies the number of exams to create.
96
+ The batch size (5 in this example) specifies the number of exams to create.
98
97
 
99
98
  ### Grade
100
99
 
@@ -53,7 +53,7 @@ packages = [
53
53
  {include = "scripts"}
54
54
  ]
55
55
  readme = "README.md"
56
- version = "0.3.1"
56
+ version = "0.3.2"
57
57
 
58
58
  [tool.poetry.dependencies]
59
59
  cerberus = "^1.3.5"
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes