Metadata-Version: 2.1
Name: crunch-cli
Version: 1.8.3
Summary: crunch-cli - CLI of the CrunchDAO Platform
Home-page: https://github.com/crunchdao/crunch-cli
Author: Enzo CACERES
Author-email: enzo.caceres@crunchdao.com
Keywords: package development template
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: requests
Requires-Dist: gitignorefile
Requires-Dist: coloredlogs
Requires-Dist: tqdm
Requires-Dist: astor
Requires-Dist: joblib
Requires-Dist: pyarrow
Requires-Dist: pandas
Requires-Dist: psutil
Requires-Dist: requirements-parser
Requires-Dist: setuptools
Requires-Dist: packaging

# CrunchDAO CLI

CrunchDAO CLI is a Python library designed for the ADIA Lab Market Prediction Competition, 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(__name__)

# Getting the data
X_train, y_train, X_test = crunch.load_data()
```

## 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.
```

## Competition Links

- [CrunchDAO Tournament](https://www.crunchdao.com)
- [ADIA Lab Market Prediction Competition](https://www.crunchdao.com/live/adialab)

## 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/)
