Metadata-Version: 2.1
Name: sharestats-item-editor
Version: 0.2.9.post2
Summary: Editor and validator for Rexam items in the ShareStats project
Home-page: https://github.com/lindemann09/rexam-item-editor
Author: Oliver Lindemann
Author-email: lindemann@cognitive-psychology.eu
License: MIT licence
Description: # ShareStats Item Editor
        
        [![GitHub](https://img.shields.io/github/license/essb-mt-section/sharestats-item-editor?style=flat)](https://github.com/essb-mt-section/sharestats-item-editor/blob/main/LICENSE)
        [![Python Version](https://img.shields.io/pypi/pyversions/sharestats-item-editor?style=flat)](https://www.python.org)
        [![PyPI](https://img.shields.io/pypi/v/sharestats-item-editor?style=flat)](https://pypi.org/project/sharestats-item-editor/)
        
        **Editor and validator for Rexam items in the ShareStats project**
        
        Feature overview
        
        * Takes into account the conventions of the [ShareStats Project](https://github.com/ShareStats) 
            * 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*)
        
        
        This program is based on (and includes copy of) the Python 
        package [RExam Item Editor](https://github.com/lindemann09/rexam-item-editor). 
        
        *The software is released under the MIT License*
        
        Oliver Lindemann, Erasmus University Rotterdam, NL
        
        
        ![screenshot](https://raw.githubusercontent.com/essb-mt-section/sharestats-item-editor/main/picts/screenshot.png)
        
        ---
        
        ## Installation
        
        Please, ensure that [Python 3](https://www.python.org/downloads/) is installed on your
        computer. If you install Python 3 on Windows, don't for get to [add Python the path](https://pychill.info/wp-content/uploads/2020/06/installation_python-1.jpg) environment variable.
        
        *ShareStats-Item-Editor* can be installed 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](https://github.com/essb-mt-section/sharestats-item-editor/releases/latest)
        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.7+ and the following libraries (see [requirements.txt](requirements.txt)):
        * PySimpleGUI
        * appdirs
        
        Optional requirement:
        * rpy2 >=3.4
        * markdown >=3.0
        
        
        ## 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](https://github.com/essb-mt-section/sharestats-item-editor/issues/new)
        any bug you encounter to the Github issue tracker.
        
        
Platform: UNKNOWN
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/markdown
Provides-Extra: rendering
