/kattis-api

Kattis online judge API

Primary LanguagePythonMIT LicenseMIT

Kattis CLI

Kattis online judge command line tool written in Python. Runs both in Python 2 and in Python 3.

Install the client

Run git clone https://github.com/Kattis/kattis-cli to clone the repository. To run the client, cd into the kattis-cli directory and run python submit.py.

The repository also contains files for running the submission client as a command from anywhere on your file system. Checkout the instructions for your operating system to see how to proceed.

Windows

To run the client as a command, you need to add the kattis-cli directory to your %PATH% variable. To do that, run setx PATH "%PATH%;C:\Users\user\Desktop\kattis-cli" where C:\Users\user\Desktop\kattis-cli is the path to your cloned repository. You can now run the command kattis from anywhere!

MacOS/Linux

To run the client as a command, you need to add the kattis-cli directory to your $PATH variable. To do that, open the file ~/.bash_profile in a text editor and add the line export PATH="$PATH:/Users/user/Desktop/kattis-cli", where /Users/user/Desktop/kattis-cli is the path to the kattis-cli directory, at the end of the file. You can now run the command kattis from anywhere! Note: You might need admin privileges to change the file.

Configuration file

Before running the submission client, you need to download a configuration file. This file includes a secret personal token that allows you to log in. It should be placed in your home directory, or in the same directory as submit.py, and be called .kattisrc.

Running the client

The easiest way to use the client is if you have named your source code to problemid.suffix, where suffix is something suitable for the language (e.g., .java for Java, .c for C, .cc or .cpp for C++, .py for Python, .cs for C#, .go for Go, and so on...).

Let's assume you're solving the problem Hello World! (with problem id hello) and that your java solution is in the file Hello.java. Then you can simply run kattis Hello.java, and the client will make the correct guesses. You will always be prompted before a submission is sent.

Note: If you get an error message like this: ModuleNotFoundError: No module named 'requests' when you run kattis it's because the module 'requests' isn't installed. To install the module, check out this StackOverflow answer.

More advanced options

The submit client can handle multiple files in a submission. For such submissions, the filename and suffix of the first file listed on the command line is the basis of the guesses. It is ok to list a file multiple times, e.g., kattis Hello.java *.java will work as intended.

In case the client guesses wrong, you can correct it by specifying a command line option. Running kattis -h will list all options. The options are:

  • -p <problem_id>: overrides problem guess
  • -m <mainclass>: overrides mainclass guess
  • -l <language>: overrides language guess
  • -f: forces submission (i.e., no prompt)