# CrunchDAO CLI
[](https://github.com/crunchdao/crunch-cli/actions/workflows/pytest.yml)
This Python library is designed for the CrunchDAO Platform, offering convenient access to competition's data and enabling effortless submission. When utilized in the command-line interface (CLI), its goal is to deliver a user experience akin to GitHub, enabling you to seamlessly push the code from your local environment.
## Installation
Use [pip](https://pypi.org/project/crunch-cli/) to install the `crunch-cli`.
```bash
pip install crunch-cli --upgrade
```
## Usage
```python
import crunch
crunch = crunch.load_notebook()
# Getting the data
X_train, y_train, X_test = crunch.load_data()
```
`crunch.load_data()` accept arguments for `read_parquet`.
```python
crunch.load_data(
engine="fastparquet"
)
```
## Submit with Crunch CLI
```bash
Usage: crunch push [OPTIONS]
Send the new submission of your code.
Options:
-m, --message TEXT Specify the change of your code. (like a commit
message)
-e, --main-file TEXT Entrypoint of your code. [default: main.py]
--model-directory TEXT Directory where your model is stored. [default:
resources]
--help Show this message and exit.
```
## Detecting the environment
Detecting whether you are running inside the runner or not, allows you to configure your program more precisely.
```python
import crunch
if crunch.is_inside_runner:
print("running inside the runner")
else:
print("running elsewhere")
model.enable_debug()
logger.set_level("TRACE")
```
## Competition Links
- [Competition Platform](https://www.crunchdao.com)
- [ADIA Lab Market Prediction Competition](https://www.crunchdao.com/live/adialab)
- [see more](https://hub.crunchdao.com/)
## Contributing
Pull requests are always welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request or open an issue in the GitHub repository.
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/crunchdao/crunch-cli",
"name": "crunch-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "package development template",
"author": "Enzo CACERES",
"author_email": "enzo.caceres@crunchdao.com",
"download_url": "https://files.pythonhosted.org/packages/e9/59/2d11d7909967a3a54d06576a4346a8f85edc8b1ca32e40ea904d6b84707e/crunch_cli-5.8.2.tar.gz",
"platform": null,
"description": "# CrunchDAO CLI\n\n[](https://github.com/crunchdao/crunch-cli/actions/workflows/pytest.yml)\n\nThis Python library is designed for the CrunchDAO Platform, offering convenient access to competition's data and enabling effortless submission. When utilized in the command-line interface (CLI), its goal is to deliver a user experience akin to GitHub, enabling you to seamlessly push the code from your local environment.\n\n## Installation\n\nUse [pip](https://pypi.org/project/crunch-cli/) to install the `crunch-cli`.\n\n```bash\npip install crunch-cli --upgrade\n```\n\n## Usage\n\n```python\nimport crunch\ncrunch = crunch.load_notebook()\n\n# Getting the data\nX_train, y_train, X_test = crunch.load_data()\n```\n\n`crunch.load_data()` accept arguments for `read_parquet`.\n\n```python\ncrunch.load_data(\n engine=\"fastparquet\"\n)\n```\n\n## Submit with Crunch CLI\n\n```bash\nUsage: crunch push [OPTIONS]\n\n Send the new submission of your code.\n\nOptions:\n -m, --message TEXT Specify the change of your code. (like a commit\n message)\n\n -e, --main-file TEXT Entrypoint of your code. [default: main.py]\n --model-directory TEXT Directory where your model is stored. [default:\n resources]\n\n --help Show this message and exit.\n```\n\n## Detecting the environment\n\nDetecting whether you are running inside the runner or not, allows you to configure your program more precisely.\n\n```python\nimport crunch\n\nif crunch.is_inside_runner:\n print(\"running inside the runner\")\nelse:\n print(\"running elsewhere\")\n\n model.enable_debug()\n logger.set_level(\"TRACE\")\n```\n\n## Competition Links\n\n- [Competition Platform](https://www.crunchdao.com)\n- [ADIA Lab Market Prediction Competition](https://www.crunchdao.com/live/adialab)\n- [see more](https://hub.crunchdao.com/)\n\n## Contributing\n\nPull requests are always welcome! If you find any issues or have suggestions for improvements, please feel free to submit a pull request or open an issue in the GitHub repository.\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n",
"bugtrack_url": null,
"license": null,
"summary": "crunch-cli - CLI of the CrunchDAO Platform",
"version": "5.8.2",
"project_urls": {
"Homepage": "https://github.com/crunchdao/crunch-cli"
},
"split_keywords": [
"package",
"development",
"template"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f12ab73b7009aec7ba635199cbb69f1048709ee5adebf7ce222116ecfea14254",
"md5": "a1dff58997681c8375bb17e0f8fbb175",
"sha256": "2f78b05ef5a4ab2ec334e7cc3e79bb4aee816cda466d2579204e918605041443"
},
"downloads": -1,
"filename": "crunch_cli-5.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a1dff58997681c8375bb17e0f8fbb175",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 105126,
"upload_time": "2025-01-11T15:37:36",
"upload_time_iso_8601": "2025-01-11T15:37:36.677398Z",
"url": "https://files.pythonhosted.org/packages/f1/2a/b73b7009aec7ba635199cbb69f1048709ee5adebf7ce222116ecfea14254/crunch_cli-5.8.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e9592d11d7909967a3a54d06576a4346a8f85edc8b1ca32e40ea904d6b84707e",
"md5": "657fb1d9d3b2523c80d0394ad38b8a97",
"sha256": "ce7a0cbbc0b0e1caffa7a48a403ae286a96f609b1791afa41bd2a0175017e4c7"
},
"downloads": -1,
"filename": "crunch_cli-5.8.2.tar.gz",
"has_sig": false,
"md5_digest": "657fb1d9d3b2523c80d0394ad38b8a97",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 79634,
"upload_time": "2025-01-11T15:37:39",
"upload_time_iso_8601": "2025-01-11T15:37:39.404704Z",
"url": "https://files.pythonhosted.org/packages/e9/59/2d11d7909967a3a54d06576a4346a8f85edc8b1ca32e40ea904d6b84707e/crunch_cli-5.8.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-11 15:37:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "crunchdao",
"github_project": "crunch-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "crunch-cli"
}
JSON
