blob: 80fefaf2fa5f80ff7207d88eaa946515097db559 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
.. mdinclude:: readme.md
Read the :ref:`quickstart`.
Setting up
----------
* Set up a MySQL/MariaDB server. The database will be generated automatically.
* Add ``smarker.conf`` to the root directory of the code. See :ref:`configfile` for the structure of this file.
* Decide how you want to run the program: with or without docker.
* Add an assessment yaml- :ref:`assessmentyaml`.
* Enroll students: ``python3 Smarker/assessments.py -s 123456789,Eden,Attenborough,E.Attenborough@uea.ac.uk``
*Smarker* can be used inside docker, see :ref:`docker` (recommended for sandboxing client code)
and through an API- see :ref:`api`.
``smarker.py`` usage
********************
Now we are ready to make some reports! For which we use the main file ``smarker.py``:
.. argparse::
:module: smarker
:func: getparser
:prog: python Smarker/smarker.py
Please note that the ``-o`` flag is required for rendering to PDFs.
``assessments.py`` usage
************************
``assessments.py`` contains many useful arguments for interacting with the database:
Also see :ref:`assessments`
.. argparse::
:module: assessments
:func: getparser
:prog: python Smarker/assessments.py
.. toctree::
:maxdepth: 2
:caption: Setting up:
quickstart.rst
configfile.rst
.. toctree::
:maxdepth: 3
:caption: Docker:
docker.rst
assessmentyaml.rst
api.rst
.. toctree::
:maxdepth: 3
:caption: Modules:
reflect.rst
database.rst
assessments.rst
api.rst
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
|
