chef-cli 1.0.1
CodeChef command line interface. ChefCLI helps competitive coders to search, view,                 and submit problems in CodeChef.
License: MIT
Requires Python: >=3.5
Keywords: chef-cli codechef cli programming

# Chef-Cli
[![Buy me a coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/UselessCoder)

![Logo](https://raw.githubusercontent.com/mkfeuhrer/chef-cli/master/screenshots/logo.png?token=AQ8RNdhzo_0zyGAhqY5omLscf31UXd1mks5bug5ywA%3D%3D)

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://github.com/mkfeuhrer/chef-cli)
[![GitHub Stars](https://img.shields.io/github/stars/mkfeuhrer/chef-cli.svg)](https://github.com/mkfeuhrer/chef-cli) 
[![Current Version](https://img.shields.io/badge/version-1.1-green.svg)](https://github.com/mkfeuhrer/chef-cli)<br>

CodeChef command line interface. ChefCLI helps competitive coders to search, view, and submit problems in CodeChef.

## Table of Contents

- [Introduction](#introduction)
- [Features](#features)
- [Installation Instruction](##installation)
- [Screenshots](#screenshots)
- [Feedback](#feedback)
- [Contributors](#contributors)
- [Contribute](#contribute)
- [Acknowledgement](#acknowledgment)

## Introduction

Chef-Cli is a command line interface which uses CodeChef’s official API. This application is for those who hate graphical application and love to do everything from terminal.  With features like sample submit and problem recommendation, It is designed to improve the overall productivity of the user.

[![Chef-CLI](http://img.youtube.com/vi/xONwEaXsgfw/0.jpg)](http://www.youtube.com/watch?v=xONwEaXsgfw)

## Features

- View Problem Statement In Terminal
- Get complete profile information about a particluar user.
- Get a graph of submissions made by the user in past one year. (Similar to submission graph of SPOJ)
- Compare profiles of two users based on the ranking in various formats. Alos get a comparison graph right on the terminal for better visualization
- Submit a problem for evaluation against sample test cases and see if it passes or not.
- Problem Recommendation
 - Recommends problem based on past solved problems by a user.
 - Uses content based recommendation system for problem recommendation.
 - Parameters - Difficulty , tags , No. of users who solved , Rating of user who solved
- Get a ranking of all the institutes on CodeChef based on the performance of students in past contests.
- Submit problems to CodeChef IDE directly from the terminal and get the final result right on the terminal.
- Get list of both upcoming and currently running contests.
- Get all details about a contest.
- Get list of all the languages on codechef.
- Get list of problems with a particular tag.
- Search an institution from registered institution on Codechef.

## Installation Instruction

- Chef-CLI is available as a python package.

- Open terminal and run ```pip install chef-cli```

- This installs the CLI app.

- Now run chef-cli --help to know the available commands

- Enjoy !!

## Screenshots

**View Problem Statements In Terminal**

![View Problem Statements In Terminal](https://raw.githubusercontent.com/mkfeuhrer/chef-cli/master/screenshots/ProblemStatement.png?token=AQ8RNaL6IFiCFDQ-ecUZ_0Yr5NI-uvXMks5bug7lwA%3D%3D)

**User's Profile Information**

![User's Profile Information](https://raw.githubusercontent.com/mkfeuhrer/chef-cli/master/screenshots/UserInfo.png?token=AQ8RNSlMia-BjEc2dR18P_TOw4L98oCfks5bug8QwA%3D%3D)

**User's Submission Graph**

![User's Submission Graph](https://raw.githubusercontent.com/mkfeuhrer/chef-cli/master/screenshots/SubmissionGraph.png?token=AQ8RNXFjiVyvQUl8GAa25sTd2xH2SNJEks5bug8nwA%3D%3D)

**Profile Comparison**

![Profile Comparison](https://raw.githubusercontent.com/mkfeuhrer/chef-cli/master/screenshots/Compare.png?token=AQ8RNUVvax5bPMpH7LxlTygtPhKuaCtDks5bug88wA%3D%3D)

**Sample Submit**

![Sample Submit](https://raw.githubusercontent.com/mkfeuhrer/chef-cli/master/screenshots/SampleSubmit.png?token=AQ8RNSwDtklwCfidU84drodtC3FnZYtMks5bug9ZwA%3D%3D)

**Recommend Problem**

![Recommend Problem](https://raw.githubusercontent.com/mkfeuhrer/chef-cli/master/screenshots/RecommendProblem.png?token=AQ8RNZuCGrJDkgjanVoN9AWa6HNabV-hks5buhBDwA%3D%3D)

**Institute Ranking**

![Institute Ranking](https://raw.githubusercontent.com/mkfeuhrer/chef-cli/master/screenshots/CollegeRanking.png?token=AQ8RNYXdq2KgGdCtUA2xJ1THgqUAa7yoks5buirHwA%3D%3D)

## Feedback

Feel free to send us feedback on [Email](mailto:mohitfeuhrer@gmail.com) or [file an issue](https://github.com/mkfeuhrer/chef-cli/issues).

## Contributors

- [Abhey Rana](https://github.com/Abhey)
- [Mohit Khare](https://github.com/mkfeuhrer)

## Contribute

- Feel free to report issues and bugs.It will be helpful for future launches of application.
- All Suggestions are welcome.
- Fork repository and Contribute.

## Acknowledgment

Thanks to [CodeChef](https://codechef.com/) for providing CodeChef Api and [Alibaba Cloud](https://www.alibabacloud.com) for providing the platform.