Metadata-Version: 2.1
Name: compdevkit
Version: 1.3.2
Summary: Developer tools for compmodels.org.
Home-page: https://github.com/comp-org/COMP-Developer-Toolkit
Author: Hank Doupe
Author-email: henrymdoupe@gmail.com
License: UNKNOWN
Description: # Comp-Developer-Toolkit
        
        `compdevkit` tests your model's functions against the [COMP criteria](https://comp-org.github.io/comp-ce/publish/functions/). If your functions pass the `compdevkit` tests, then you can be reasonably sure that the functions will work on COMPmodels.org.
        
        ## Install `compdevkit`
        
        ```bash
        pip install compdevkit
        ```
        
        ## Set up the `comp` directory
        
        ```bash
        cdk-init
        ```
        
        ## Test your functions
        
        ```python
        from compdevkit import FunctionsTest
        
        import matchups
        
        def test_get_parameters():
            ta = FunctionsTest(
                get_inputs=matchups.get_inputs,
                validate_inputs=matchups.validate_inputs,
                run_model=matchups.get_matchup,
                ok_adjustment={"matchup": {"pitcher": [{"value": "Max Scherzer"}]}},
                bad_adjustment={"matchup": {"pitcher": [{"value": "Not a pitcher"}]}}
            )
            ta.test()
        
        ```
        
        ## Run the tests
        
        ```bash
        py.test compconfig -v
        ```
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
