Metadata-Version: 2.1
Name: kttool
Version: 1.3.3
Summary: Kattis command line tool
Home-page: https://github.com/heiseish/kt
Author: Dao Truong Giang
Author-email: dtrnggiang@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests (==2.28.1)
Requires-Dist: bs4 (==0.0.1)
Requires-Dist: emoji (==0.6.0)
Requires-Dist: reprint (==0.5.2)
Requires-Dist: psutil (==5.9.4)
Requires-Dist: pytest (==7.2.0)
Requires-Dist: typing-extensions (==4.1.1)

# <img src="https://raw.githubusercontent.com/heiseish/kt/master/img/icon.png" width="50" height="30"> Kattis unofficial command line helper

![pypi](https://img.shields.io/pypi/v/kttool.svg)
![wheel](https://img.shields.io/pypi/wheel/kttool.svg)
![license](https://img.shields.io/pypi/l/kttool.svg)
![download](https://static.pepy.tech/badge/kttool)

Inspired by (and works well with) xalanq's [codeforce tool](https://github.com/xalanq/cf-tool)

<img src="https://raw.githubusercontent.com/heiseish/kt/master/img/kattis_icon.png">

## Sample usage

### 1. Config your template type

First and foremost, [download your kattisrc file](https://open.kattis.com/download/kattisrc) and put it in your `$HOME` directory (ie `~/.kattisrc`). After that, run

```bash
kt config
```

to configure your code template. This will allow the tool to quickly generate code template for your problem.
<img src="https://raw.githubusercontent.com/heiseish/kt/master/img/config.png">

### 2. Generate folder for problem statement and sample intputs and outputs

```bash
kt gen <problem_id>
```

For example, if you want to attempt problem [Distinctive Character](https://open.kattis.com/problems/distinctivecharacter), the problem ID is `distinctivecharacter`. From your kattis working folder, type in

```bash
kt gen distinctivecharacter
```

You should be able to see 2 set of sample inputs/outputs generated in a folder called `distinctivecharacter`
<img src="https://raw.githubusercontent.com/heiseish/kt/master/img/gen.png">

After that, you can `cd` into the folder and start working on the problem.

### 3. Test your code

If you've set up your config properly, you should be ready to test whether your code pass sample input and output. Simply run

```bash
kt test
```

And observe the difference ..

<img src="https://raw.githubusercontent.com/heiseish/kt/master/img/diff.png">

### Submit file and check result on the terminal

From your current problem folder

```bash
kt submit
```

You should be able to see how many test cases your code has passed so far
<img src="https://raw.githubusercontent.com/heiseish/kt/master/img/ac.png">

```
$ kt open -h
Usage: kt open [problem_id]

    Open the default browser with the link to the full problem statement on Kattis. If no problem id is provided, the problem id wil be deduced using the
    current directionary name

    Options
    --------
    problem_id: Kattis problem id
```

### Update version of kttool

Check current version of kttool

```bash
kt version
```

If there is a newer version, you can run

```bash
kt update
```

to check.

## Installation

```bash
pip install --upgrade kttool
```

## Reference

- https://github.com/Kattis/kattis-cli
- https://github.com/xalanq/cf-tool

# License

[MIT License](LICENSE)

# Remaining features yet to be implemented

- [ ] Multiple profiles. Ability to switch between Kattis open domain and competition domain with ease


