Puzzle Chum

Helper scripts to create, test, and benchmark your algorithms! (also downloads kattis test samples automatically ;) )

(Only works for rust, c++ and python currently, but feel free to open an Issue for further language support)

Installation

Arch linux

Two options:

1. Run just install-arch to install using pacman. (requires just)
2. Run the following code

python3 -m build
makepkg --syncdeps --force --clean
sudo pacman -U puzzlechum-*-x86_64.pkg.tar.zst

Using pip

I recommend installing with pipx, and it is used just like pip is used.

python3 -m build
pipx install .

but if you want to, you can exchange pipx with pip.

Requirements

Required regardless of what language you are programming with:

• requests - python requests package

Optional dependencies:

• hyperfine - only required for benchmarking!

Testing python code

• pypy3 - required for python code compilation

Usage

Install the package and run chum --help to see available commands.

chum runs anywhere beneath the problems root, which you set with chum init. This is so that chum knows where to search for your solutions.

Main commands:

• chum new [problem name] - create a new problem, and tests are downloaded automatically if the [problem name] matches an open kattis problem ID.
• chum test [problem name] - compile and run tests, see the --benchmark flag for also outputting performance numbers and solution comparisons.
  • you may have several solutions in your problem folder, just make sure that each begin with [problem name] so that chum recognizes them as solutions to be compared.

Examples

new example:

➤ chum new twosum
Copied template to 'twosum/twosum.cpp'
Test samples successfully downloaded to '/home/.../kattis-problems/.chumtests/twosum'

test --benchmark example:

➤ chum test twosum --benchmark
Compiling source files: [twosum/twosum.cpp, twosum/twosum.rs]
Running tests: [.chumtests/twosum/sample1.in, .chumtests/twosum/sample2.in]

twosum/twosum.cpp
  ✔ - PASSED .chumtests/twosum/sample1.in
  ✔ - PASSED .chumtests/twosum/sample2.in
twosum/twosum.rs
  ✔ - PASSED .chumtests/twosum/sample1.in
  ✔ - PASSED .chumtests/twosum/sample2.in

...

Fastest executions
 (1) twosum.cpp
 (2) twosum.rs
         (1)       (2)
sample1  319.7 µs  489.4 µs
sample2  319.2 µs  485.2 µs

Failing test example:

➤ chum test twosum
Compiling source files: [twosum/twosum.cpp, twosum/twosum.rs]
Running tests: [.chumtests/twosum/sample1.in, .chumtests/twosum/sample2.in]

.chumtests/twosum/sample2.ans
FAIL!
    at: line 1
    got: 2
    expected: 4

twosum/twosum.cpp
  ✔ - PASSED .chumtests/twosum/sample1.in
  ✗ - FAILED .chumtests/twosum/sample2.in
twosum/twosum.rs
  ✔ - PASSED .chumtests/twosum/sample1.in
  ✔ - PASSED .chumtests/twosum/sample2.in

Folder structure

problems/
    problem1_name/
        tests/
            sample1.in
            sample1.ans
        problem1_name*.cpp
        problem1_name*.rs
        problem1_name*.py

    problem2_name/
        ...
    ...