Editor and validator for Rexam items in the ShareStats project
Project description
ShareStats Item Editor
Editor and validator for Rexam items in the ShareStats project
Feature overview
- Takes into account the conventions of the ShareStats Project
- violation checks of file and folder naming and required meta-information
- required subfolder structure
- joining bilingual items in the database (Dutch, English)
- Convenience functions for item editing
- support for generating and naming new items
- auto-fix function for some violations of the conventions and R
markdown syntax - multiple choice items: correct answers can be indicated with an
#
(instead of*
).exsolution
will be set automatically.
- R markdown rendering check (experimental, requires R)
Released under the MIT License
Oliver Lindemann, Erasmus University Rotterdam, NL
Installation
Python / Pip
Users familiar with Python are suggested to install python3
and use pip
.
python3 -m pip install sharestats-item-editor
To run ShareStatsItemEditor call
sharestats-item-editor
or
python3 -m sharestats_item_editor
Dependencies: Python 3.5+ and the following libraries (see requirements.txt):
- PySimpleGUI
- appdirs
Optional requirement:
- rpy2 >=3.4
Windows
Windows user may run StatsShare-Item-Editor without installing Python.
Download the
latest executable file, sharestats_item_editor.exe
, via the
release website
and execute it. Using the executable file instead of installing the appliaction
via pip
results in a slowly launching application.
Note, depending on your security setting, you may receive a security alert from Windows defender, because the executable is not registered Windows application.
Rendering Rmd File
To render Rmd files directly via the StatsShare-Item-Editor, you need
a functioning
installation of R including the R-package exams
.
If you used the Python installation, install the
Python-package rpy2
(pip install rpy2
).
Windows user find two executable files for StatsShare-Item-Editor, one with and one without R rendering support. StatsShare-Item-Editor with rendering does not work on computers without a R installation.
Bugs: Please submit any bug you encounter to the Github issue tracker.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sharestats-item-editor-0.1.13.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2771587ac2a1197af511c67cbd5776958f8d68ef4914d486948b9e17268cb05b |
|
MD5 | 00db081e3b7579c5f5ef309a236362ef |
|
BLAKE2b-256 | ccd3b190326aeb8d8a35da4f9637b132432201e9d661137c2381aac0bb8ce48c |
Hashes for sharestats_item_editor-0.1.13-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 365efff2ad7e02810dee6fae32af88852a4e9d0f425990951c0e75fe11783da8 |
|
MD5 | 722168444948d061ab14647994cf12a8 |
|
BLAKE2b-256 | e161ce0defc13a66b6a17a4e40c643cf263a614072891e5a3a89251f51ad4e0f |