Metadata-Version: 2.1
Name: sheetwhat
Version: 0.1.9
Summary: Submission correctness tests for spreadsheets
Home-page: https://github.com/datacamp/sheetwhat
Author: Vincent Vankrunkelsven
Author-email: vincent@datacamp.com
Maintainer: Jeroen Hermans
Maintainer-email: content-engineering@datacamp.com
License: UNKNOWN
Description: # sheetwhat
        
        [![Build Status](https://travis-ci.org/datacamp/sheetwhat.svg?branch=master)](https://travis-ci.org/datacamp/sheetwhat)
        [![codecov](https://codecov.io/gh/datacamp/sheetwhat/branch/master/graph/badge.svg)](https://codecov.io/gh/datacamp/sheetwhat)
        [![PyPI version](https://badge.fury.io/py/sheetwhat.svg)](https://badge.fury.io/py/sheetwhat)
        [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdatacamp%2Fsheetwhat.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdatacamp%2Fsheetwhat?ref=badge_shield)
        
        `sheetwhat` enables you to write Submission Correctness Tests (SCTs) for interactive Spreadsheet exercises on DataCamp.
        
        - If you are new to teaching on DataCamp, check out https://instructor-support.datacamp.com.
        - If you want to learn what SCTs are and how they work, visit [this article](https://instructor-support.datacamp.com/courses/course-development/submission-correctness-tests) specifically.
        - For a complete overview of all functionality inside `sheetwhat` and articles about what to use when, consult https://sheetwhat.readthedocs.io.
        
        ## Installing
        
        ```
        pip install sheetwhat
        ```
        
        ## Demo
        
        Sheetwhat is typically used in a web application, but you can also experiment with its functions on your local machine.
        SCT functions that fail will throw a `TestFail` error.
        
        ```python
        # Setup: make all checking functions available
        from sheetwhat.sct_syntax import SCT_CTX
        globals().update(SCT_CTX)
        
        # Setup: set up state with student data, solution data and SCT range
        from sheetwhat.State import State
        from protowhat.Reporter import Reporter
        Ex.root_state = State(
            {'values': [["a", "a"]], "formulas": [["=B1"]]},
            {'values': [["b", "b"]], "formulas": [["=B1"]]},
            "A1",
            Reporter()
        )
        
        # Experiment interactively with SCTs
        # Passes, as formulas at A1 match
        Ex().has_equal_formula()
        
        # Fails, as values at A1 do not match
        Ex().has_equal_value()
        ```
        
        ## Testing
        
        ```
        pip install -r requirements.txt
        pip install -e .
        pytest
        ```
        
        
        ## License
        [![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fdatacamp%2Fsheetwhat.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fdatacamp%2Fsheetwhat?ref=badge_large)
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
