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 -U 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.14.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 317ecf40a44ae0a4313196163fb4c21427a51d39a4cc32a4bce4417d1cfc9556 |
|
MD5 | bc4c098a717e9f559c7077c48e1c36f5 |
|
BLAKE2b-256 | 154020db13d3be5b34716be77077f5d07b98c75c3e6f1491623f01683c95355e |
Hashes for sharestats_item_editor-0.1.14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9b3df24fa4e776b7e09db111bd7dda12e2e7f8569c08fddaa447c1ee2f780a80 |
|
MD5 | 9a969d18c5296db9483c41f3a92d2087 |
|
BLAKE2b-256 | 8020d689cf730bdceebc21b77325f219fd8ce1ad15edb03c2de562aa1115ecf0 |