CodeGra.fs should work on all popular operating systems: GNU/Linux, MacOS and Windows. The support for windows is currently experimental: we would love to hear your feedback!
GNU/Linux and MacOS
The installation for GNU/Linux and mac is done using
sudo pip install CodeGra.fs. This installs three scripts,
cgfs used to mount the file-system,
cgfs-qt a GUI that can be used to mount the file-system, and
used by editor plugins. You can also install
cgfs by giving
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. For MacOS this will probably mean you need to install
Python3, you can do this using homebrew (
brew install python) or by doing python here.
On GNU/Linux and MacOS CodeGra.fs depends on:
Installation on windows can also be done by using
pip, however we also supply
an installer. You can download the installer for the latest release
here. The installer doesn't
install the command line
cgfs script, if you need this script for whatever
reason simply install the package using
When installing using pip CodeGra.fs depends on:
Command line usage
The basic used of the
cgfs can be viewed by executing
cgfs --help. The idea
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.
If you prefer to use a GUI you can use the
cgfs-qt command. This is a simple
GUI to use CodeGra.fs. Please note that this GUI is still in alpha state. To use
the GUI fill in all required fields, you can get help for each field by clicking
the question mark, and click mount. You will now see a output field stating
'Mounting...' and a bit later 'Mounted...'. You can now use the file system as
normal. To unmount simply click 'Stop!'.
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:
||✗||Root||Location of the api socket||Single line with file location|
||✗||Root||Mode file system||
||✗||Assignment||Id of this assignment||Single line with id|
||✓||Assignment||Settings for this assignment||Ini file with settings|
||✓||Assignment||Rubric for this assignment, editing changes the rubric||See
||✗||Assignment||Help file for the rubric file||Plain text file|
||✓||Submission||The general feedback for this submission||Plain text file|
||✓||Submission||The grade for this submission||Single float or empty to delete or reset2 the grade|
||✓3||Submission||The rubric for this submission||Markdown file where a ticked box means the item is selected.|
||✗||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
__RESET__ to any writable special file to reset it to its server state.
You can use CodeGra.fs for any CodeGrade instance. The application does a
version check at every startup, this is done by doing a request to
https://codegra.de/.cgfs.version. We do not collect any personal information
at this route. It is currently not possible to disable this version check. If
this request is a problem for you, it is possible to block this host/url:
CodeGra.fs will continue to function normally; creating a pull request to make
this check optional is also possible of course!
Please report any issues by creating a GitHub issue
here, if possible please
include link to uploaded a log output when encountering the bug using the
verbose mode (use the
--verbose command line flag, or click 'verbose' in the
GUI). You can upload logs to any pastebin like website, for example
Commercial support of CodeGra.fs is available and included in a commercial CodeGrade instance. We would love to provide more information, please send an e-mail to email@example.com!
CodeGra.fs as a whole is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0-only). All license identifiers used in this product are SPDX license identifiers.