Metadata-Version: 2.2
Name: jupyter2pytest
Version: 0.3.4
Summary: Converts Jupyter notebooks into pytest capable test files.
Author-email: Garrett Credi <garrettcredi@gmail.com>
License: MIT License
        
        Copyright (c) 2023 University of Illinois
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/dsdiscovery/jupyter2pytest
Project-URL: Repository, https://github.com/dsdiscovery/jupyter2pytest
Keywords: pytest,jupyter,autograding
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Education
Classifier: Typing :: Typed
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: nbformat
Requires-Dist: tblib

# Jupyter Notebook Grader

This is a script that will compile a jupyter notebook with a specified structure into a python script that is pytest compatible.

For use in code, `extractor` handles extracting cells from a notebook with a given prefix into a `TestcellBlock` object. `compiler` deals more with taking an assignment notebook and a notebook with testcases,
which can be and often are the same notebook, and with specified prefixes and writing it into a python file capable of running against pytest. For example, the prefix for assignment code could be 
`### ASSIGNMENT CODE for Puzzle (.*) ==` where the group in the regex determines what test the code applies to. Prefixes must have at least one group to match against, and that first group will be the
identification used. To run as a CLI tool, use `python3 -m jupyter2pytest [code file] [code prefix] [test file] [test prefix] [pytest output file]`.
