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
Please, ensure that Python 3 is installed on your computer. If you install Python 3 on Windows, don't for get to add Python the path environment variable.
ShareStats-Item-Editor can be istalled via the Pythons package manager pip
. Open a shell and call:
python -m pip install -U sharestats-item-editor
(This command is also used the update an existsing installing of ShareStats-Item-Editor.)
To run ShareStats-Item-Editor called this command via your shell:
sharestats-item-editor
Windows Executables
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.
Note, depending on your security settings, you may receive a security alert from Windows defender, because the executable is not a registered Windows application.
Using this installation method is convenient has however two disadvantages.
(a) Windows may classify the executable erroneously as a virus and prevents
you from installing.
(b) Using the executable instead of installing the application via pip
results
in a slow launching application.
Dependencies
Python 3.5+ and the following libraries (see requirements.txt):
- PySimpleGUI
- appdirs
Optional requirement:
- rpy2 >=3.4
Rendering Rmd File (work in progress)
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.23.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c07ba2ece34412ffdaa7ab06a2183021547ddc6b1f3d545aa43f3e98f60b0df0 |
|
MD5 | ee855186bd53b2beff33b6c8ba055849 |
|
BLAKE2b-256 | e8d18963ee4de6c54bcaedd90e73db91e0d55b05e13f47e3072437fcea114bb8 |
Hashes for sharestats_item_editor-0.1.23-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 206b334c741fbdfb61a25b13d2a743add2484bb9b7612ac44ca766725e66963d |
|
MD5 | 6d0d6b0ab2afbaae08542366ee9750c5 |
|
BLAKE2b-256 | 4a256040d84fba0ebdfce3868eae43b47472905110ef65c58cb81c94e6cddb04 |