You can install this package using pip. At the moment this package is not yet
in the pip repositories, however you can install it directly from git: sudo pip3 install git+https://github.com/CodeGra-de/CodeGra.fs.git. This installs
two scripts, cgfs used to mount the file-system and cgapi-consumer used by
editor plugins. You can also install cgfs by giving pip the --user flag,
however make sure $HOME/.local/bin is in your $PATH in this case.
Please note that pip3 is used, this because CodeGra.fs only with works with
python 3.5 or higher. It depends on:
The basic used of the cgfs can be viewed by executing cgfs --help. The idea
behind cgfs is that you mount a CodeGra.de instance on you local computer, in
the mounted folder you can now browse, alter and delete files submitted by
yourself and people you have to grade.
The basic layout of the file-system is /course/assingment/submission - submission_time, so for example /datastructures/linked-list/Thomas Schaper - 2017-11-14T13:41:26.324712. All files that a student submitted can be found in
the submission folder.
The file-system also contains a few special files, these are files that are not submitted by a student but can be used to control CodeGra.de. These files are validated on a close, which fails if the file format is not correct. The following special files exist:
| Name | Editable1 | Location | Use | Format |
|---|---|---|---|---|
.api.socket |
✗ | Root | Location of the api socket | Single line with file location |
.cg-mode |
✗ | Root | Mode file system | FIXED or NOT_FIXED |
.cg-assignment-id |
✗ | Assignment | Id of this assignment | Single line with id |
.cg-assignment-settings.ini |
✓ | Assignment | Settings for this assignment | Ini file with settings |
.cg-edit-rubric.md |
✓ | Assignment | Rubric for this assignment, editing changes the rubric | See .cd-edit-rubric.help |
.cg-edit-rubric.help |
✗ | Assignment | Help file for the rubric file | Plain text file |
.cg-feedback |
✓ | Submission | The general feedback for this submission | Plain text file |
.cg-grade |
✓ | Submission | The grade for this submission | Single float or empty to delete or reset2 the grade |
.cg-rubric.md |
✓3 | Submission | The rubric for this submission | Markdown file where a ticked box means the item is selected. |
.cg-submission-id |
✗ | Submission | Id of this submission | Single line with id |
1: Only if you have the correct permissions.
2: The grade is reset if a rubric grade is available, otherwise it is deleted.
3: Only markdown checkboxes should be changed.
It can happen that you didn't follow the exact format of the special file and
can't easily recover anymore. This isn't a really big deal, you can write the
string __RESET__ to any writable special file to reset it to its server state.
CodeGra.fs is best used in combination with an editor plugin, such plugins exist for emacs and atom and more are being created.
This code is licensed under AGPL-v3, see the license file for the exact license as this information may be out of date.