{ "info": { "author": "Hank Doupe", "author_email": "henrymdoupe@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# Compute Studio Kit\n\n`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.\n\nCompute Studio Kit also provides a helper command for retrieving your [Compute Studio API](https://docs.compute.studio/api/guide/) token.\n\n## Install `cs-kit`\n\n```bash\npip install cs-kit\n```\n\n## Set up the `cs-config` directory\n\n```bash\n$ csk-init\n$ tree cs-config/\ncs-config/\n\u251c\u2500\u2500 cs_config\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 functions.py\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 tests\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 __init__.py\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 test_functions.py\n\u251c\u2500\u2500 install.sh\n\u2514\u2500\u2500 setup.py\n\n```\n\n## Write your functions in `cs-config/cs_config/functions.py`\n\n```python\n# Write or import your Compute Studio functions here.\n\n\ndef get_version():\n pass\n\n\ndef get_inputs(meta_param_dict):\n pass\n\n\ndef validate_inputs(meta_param_dict, adjustment, errors_warnings):\n pass\n\n\ndef run_model(meta_param_dict, adjustment):\n pass\n\n```\n\n## Test your functions in `cs-config/cs_config/tests/test_functions.py`\n\n```python\nfrom cs_kit import CoreTestFunctions\n\nfrom cs_config import functions\n\n\nclass TestFunctions1(CoreTestFunctions):\n get_version = functions.get_version\n get_inputs = functions.get_inputs\n validate_inputs = functions.validate_inputs\n run_model = functions.run_model\n ok_adjustment={\"matchup\": {\"pitcher\": [{\"value\": \"Max Scherzer\"}]}}\n bad_adjustment={\"matchup\": {\"pitcher\": [{\"value\": \"Not a pitcher\"}]}}\n\n```\n\n## Run your cs-config tests\n\n```bash\npy.test cs-config\n```\n\n## Write your installation instructions in `cs-config/install.sh`\n\n```bash\nconda install your-project\n```\n\n## Get your [Compute Studio API](https://docs.compute.studio/api/guide/) token\n\n```bash\n$ csk-token --username myuser --password mypass\nToken: your-token-here\n```\n\n## Run the compute-studio-kit tests\n\n```bash\npy.test cs_kit -v\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/compute-studio-org/Compute-Studio-Toolkit", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "cs-kit", "package_url": "https://pypi.org/project/cs-kit/", "platform": "", "project_url": "https://pypi.org/project/cs-kit/", "project_urls": { "Homepage": "https://github.com/compute-studio-org/Compute-Studio-Toolkit" }, "release_url": "https://pypi.org/project/cs-kit/1.8.1/", "requires_dist": [ "paramtools", "cs-storage" ], "requires_python": "", "summary": "Developer tools for compute.studio.", "version": "1.8.1" }, "last_serial": 5856886, "releases": { "1.8.0": [ { "comment_text": "", "digests": { "md5": "84e9a38c27d81e9846462d5900d8f2f3", "sha256": "2d1226db0b22d1b81d5cb36af3e648ffaf8e2ecb543e1cd6cc594302bcaf514f" }, "downloads": -1, "filename": "cs_kit-1.8.0-py3-none-any.whl", "has_sig": false, "md5_digest": "84e9a38c27d81e9846462d5900d8f2f3", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8919, "upload_time": "2019-09-13T20:49:05", "url": "https://files.pythonhosted.org/packages/0c/3f/aa635877b025347bde253e95a5d81ca99c82dcef2768e5bd8e7594ae1ccc/cs_kit-1.8.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "5e74c95fb7daf9ad09478f40ae006593", "sha256": "c8b39b9dfdaf046b8558b722374c7fb7c00d16d7764a84a462ab5e2038cc88f0" }, "downloads": -1, "filename": "cs-kit-1.8.0.tar.gz", "has_sig": false, "md5_digest": "5e74c95fb7daf9ad09478f40ae006593", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6274, "upload_time": "2019-09-13T20:49:07", "url": "https://files.pythonhosted.org/packages/3a/de/0fbba63c8bf00cd57377f5cad4a2731fe4ac78cd38ad75e4c2f40dd40f8b/cs-kit-1.8.0.tar.gz" } ], "1.8.1": [ { "comment_text": "", "digests": { "md5": "100d5be1cd21c45e788a49964c272691", "sha256": "66e5fc37463ff261d8e9cb8ab5c50c7e16fc1abaf4e217f8a83a99074b4333de" }, "downloads": -1, "filename": "cs_kit-1.8.1-py3-none-any.whl", "has_sig": false, "md5_digest": "100d5be1cd21c45e788a49964c272691", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8912, "upload_time": "2019-09-19T14:41:50", "url": "https://files.pythonhosted.org/packages/61/bd/87016945129017c1454dc7a5464709cadef6c5ec8a628092576e004bd466/cs_kit-1.8.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a548b3a5991aa3d02aed9c1e8922d489", "sha256": "95d21e33e8834aedbde561da1fca1057f752691d3cecf1d4ea8dde7f91f5f336" }, "downloads": -1, "filename": "cs-kit-1.8.1.tar.gz", "has_sig": false, "md5_digest": "a548b3a5991aa3d02aed9c1e8922d489", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6278, "upload_time": "2019-09-19T14:41:52", "url": "https://files.pythonhosted.org/packages/e2/4c/4969bf59d2c5098973b714662266edb31112c727ccdd7af6c25f64615ac9/cs-kit-1.8.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "100d5be1cd21c45e788a49964c272691", "sha256": "66e5fc37463ff261d8e9cb8ab5c50c7e16fc1abaf4e217f8a83a99074b4333de" }, "downloads": -1, "filename": "cs_kit-1.8.1-py3-none-any.whl", "has_sig": false, "md5_digest": "100d5be1cd21c45e788a49964c272691", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8912, "upload_time": "2019-09-19T14:41:50", "url": "https://files.pythonhosted.org/packages/61/bd/87016945129017c1454dc7a5464709cadef6c5ec8a628092576e004bd466/cs_kit-1.8.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "a548b3a5991aa3d02aed9c1e8922d489", "sha256": "95d21e33e8834aedbde561da1fca1057f752691d3cecf1d4ea8dde7f91f5f336" }, "downloads": -1, "filename": "cs-kit-1.8.1.tar.gz", "has_sig": false, "md5_digest": "a548b3a5991aa3d02aed9c1e8922d489", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6278, "upload_time": "2019-09-19T14:41:52", "url": "https://files.pythonhosted.org/packages/e2/4c/4969bf59d2c5098973b714662266edb31112c727ccdd7af6c25f64615ac9/cs-kit-1.8.1.tar.gz" } ] }