Metadata-Version: 2.1
Name: cs-kit
Version: 1.12.0
Summary: Developer tools for compute.studio.
Home-page: https://github.com/compute-studio-org/Compute-Studio-Toolkit
Author: Hank Doupe
Author-email: henrymdoupe@gmail.com
License: UNKNOWN
Description: # Compute Studio Kit
        
        `cs-kit` tests your model's functions against the [Compute Studio criteria](https://docs.compute.studio/publish/functions/). If your functions pass the `cs-kit` tests, then you can be reasonably sure that the functions will work on compute.studio.
        
        Compute Studio Kit also provides a helper command for retrieving your [Compute Studio API](https://docs.compute.studio/api/guide/) token.
        
        ## Install `cs-kit`
        
        ```bash
        pip install cs-kit
        ```
        
        ## Set up the `cs-config` directory
        
        ```bash
        $ csk-init
        $ tree cs-config/
        cs-config/
        ├── cs_config
        │   ├── functions.py
        │   ├── __init__.py
        │   └── tests
        │       ├── __init__.py
        │       └── test_functions.py
        ├── install.sh
        └── setup.py
        
        ```
        
        ## Write your functions in `cs-config/cs_config/functions.py`
        
        ```python
        # Write or import your Compute Studio functions here.
        
        
        def get_version():
            pass
        
        
        def get_inputs(meta_param_dict):
            pass
        
        
        def validate_inputs(meta_param_dict, adjustment, errors_warnings):
            pass
        
        
        def run_model(meta_param_dict, adjustment):
            pass
        
        ```
        
        ## Test your functions in `cs-config/cs_config/tests/test_functions.py`
        
        ```python
        from cs_kit import CoreTestFunctions
        
        from cs_config import functions
        
        
        class TestFunctions1(CoreTestFunctions):
            get_version = functions.get_version
            get_inputs = functions.get_inputs
            validate_inputs = functions.validate_inputs
            run_model = functions.run_model
            ok_adjustment={"matchup": {"pitcher": [{"value": "Max Scherzer"}]}}
            bad_adjustment={"matchup": {"pitcher": [{"value": "Not a pitcher"}]}}
        
        ```
        
        ## Run your cs-config tests
        
        ```bash
        py.test cs-config
        ```
        
        ## Write your installation instructions in `cs-config/install.sh`
        
        ```bash
        conda install your-project
        ```
        
        ## Get your [Compute Studio API](https://docs.compute.studio/api/guide/) token
        
        ```bash
        $ csk-token --username myuser --password mypass
        Token: your-token-here
        ```
        
        ## Run the compute-studio-kit tests
        
        ```bash
        py.test cs_kit -v
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
