Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 1.39 KB

README.md

File metadata and controls

64 lines (40 loc) · 1.39 KB

Kattis API

build

A python wrapper for the non-existent Kattis API.

Usage

You can simply install the package using pip

$ pip install kattis

Getting Started

import the kattis module

import kattis

Examples

Some examples to get started.

Authentication

You can authenticate a Kattis user by calling kattis.auth, this will return a KattisUser object with a few callable methods.

user = kattis.auth('username', 'password')

User Methods

Methods that are callable on a KattisUser object.

user.problems(pages) -> dict: Fetches solved user problems

user.stats() -> dict: Fetches relevant user statistics

user.data() -> dict: Combines problems and statistics

user = kattis.auth('username', 'password')

problems = user.problems(1)
stats = user.stats()
info = user.data()

Problems

You can fetch kattis problems by ID or by full pages

kattis.problem(id) -> dict: Fetches problem information for a single problem

kattis.problems(pages) -> list[dict] Fetches problem information across specified pages

problem = kattis.problem('2048') # Fetches information for problem with ID '2048'
problems = kattis.problems(2) # Fetches all problems on first 2 pages