# 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/38/da/a4c3e6ecb2f4489af7e5fc3f63f589f2ee43cc2ddd608e0e721279ce8756/crunch_cli-5.4.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.4.2",
"project_urls": {
"Homepage": "https://github.com/crunchdao/crunch-cli"
},
"split_keywords": [
"package",
"development",
"template"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "91bea7f594219f86b276cd995bdcdeb36bc0e74715d91623d7a058d7577bd6fa",
"md5": "01e2bee70dc5773c167480a73b2f71bd",
"sha256": "d8cc1f0e48c17287d3156ed79f227206486891d361ef239bd228d80c1d8f9610"
},
"downloads": -1,
"filename": "crunch_cli-5.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "01e2bee70dc5773c167480a73b2f71bd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 97379,
"upload_time": "2024-11-13T19:37:48",
"upload_time_iso_8601": "2024-11-13T19:37:48.963268Z",
"url": "https://files.pythonhosted.org/packages/91/be/a7f594219f86b276cd995bdcdeb36bc0e74715d91623d7a058d7577bd6fa/crunch_cli-5.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "38daa4c3e6ecb2f4489af7e5fc3f63f589f2ee43cc2ddd608e0e721279ce8756",
"md5": "fcc4feced83fe85cecb59730bf21416a",
"sha256": "8e9b49a0f4b69224614ae4817ba503fe9147e6c76dfdf96a0cf431b9c75c4b85"
},
"downloads": -1,
"filename": "crunch_cli-5.4.2.tar.gz",
"has_sig": false,
"md5_digest": "fcc4feced83fe85cecb59730bf21416a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 72484,
"upload_time": "2024-11-13T19:37:50",
"upload_time_iso_8601": "2024-11-13T19:37:50.096137Z",
"url": "https://files.pythonhosted.org/packages/38/da/a4c3e6ecb2f4489af7e5fc3f63f589f2ee43cc2ddd608e0e721279ce8756/crunch_cli-5.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 19:37:50",
"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
