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
Windows
Windows user may run StatsShare-Item-Editor without installing Python (see below).
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.
MacOS / Linux
Ensure that Python 3 is installed on your computer.
You can then install ShareStats-Item-Editor via pip
. To do so, open a command line terminal and enter:
sudo python3 -m pip install -U sharestats-item-editor
To run ShareStats-Item-Editor call
sharestats-item-editor
Python / Pip
Users familiar with Python are always suggested to install ShareStats-Item-Editor via pip
.
(Ensure that Python 3 is installed on your
computer.)
python3 -m pip install -U sharestats-item-editor
To run ShareStatsItemEditor call either 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
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 don't use the Windows executable, 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.20.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0efff75d85a8534cdb7e355145d168cc10737811186c42cfd168261b0021d54c |
|
MD5 | 32976b3b3e70baff5fd21124e03c0673 |
|
BLAKE2b-256 | 90ffe4cc9136eff5d04510d961311481d2b5dcae1a8ef8884720e1d59789253e |
Hashes for sharestats_item_editor-0.1.20-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7ab01f0a0a8711923489d57432c274d9b2d9e41218eade97cf4e150adc2bec8 |
|
MD5 | 0496fec7ecefef13cfcf25ae7513ed55 |
|
BLAKE2b-256 | c17106057d1cc1ef0c20a5cdb3fdce325c0712555f68c75bf348201b4e8590db |