Skip to content

CLAUDE.md

Latest commit

 

History

History
66 lines (46 loc) · 2.9 KB

CLAUDE.md

File metadata and controls

66 lines (46 loc) · 2.9 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

A Python CLI tool for competitive programming on Codeforces. Allows users to parse problems, run local test cases, and submit solutions with real-time verdict tracking from the terminal.

Build & Development Commands

# Install dependencies and project (development)
uv sync

# Run CLI
uv run cf --help

# Build wheel
uv build

# Add a dependency
uv add <package>

There are no tests in this project.

Architecture

Entry Point: cf/__init__.py - Click CLI group with custom RichGroup class for formatted help output. Commands registered via commands.add_command().

Command Modules (each file = one Click command):

  • cf/config.py - Store credentials in ~/.codeforces.uwu (JSON)
  • cf/contests.py - List contests or view problems in a specific contest
  • cf/parse.py - Scrape problem statements and sample test cases, save as .input.test/.output.test files
  • cf/run.py - Execute solutions locally against parsed test cases (Python, C, C++)
  • cf/submit.py - Submit solutions and track verdicts via WebSocket (wss://pubsub.codeforces.com/ws/)
  • cf/unsolved.py - List user's unsolved problems
  • cf/edit.py - Open contest directories in VSCode/Vim/Neovim

Core Utilities (utils.py):

  • get_config() - Load config from ~/.codeforces.uwu
  • get_bp(lang) - Load boilerplate templates from ~/cf_boilerplates/template.{lang}
  • CFClient - HTTP session handler with login and CSRF token management

Key Dependencies: Click (CLI), Rich (terminal UI), BeautifulSoup4 (HTML parsing), requests (HTTP), websocket-client (real-time updates), undetected-chromedriver (browser automation for authentication)

Config Files:

  • ~/.codeforces.uwu - Username and directory settings (JSON)
  • ~/.codeforces.cookies - Saved session cookies for authenticated requests (JSON)

Authentication

Codeforces uses Cloudflare protection which blocks automated browsers. We use undetected-chromedriver to bypass this. The authentication flow is:

  1. On first login (via cf config or cf submit), Chrome opens for user to login manually
  2. After successful login, cookies are saved to ~/.codeforces.cookies
  3. Subsequent requests reuse saved cookies (no browser needed)
  4. If cookies expire, browser opens again for re-authentication

The CFClient class in utils.py handles this with login(), _verify_login(), _save_cookies(), and _load_cookies() methods. Password is not stored - only username and cookies.

Code Patterns

  • All web scraping uses BeautifulSoup on Codeforces HTML pages
  • Commands verify they're running from a valid contest directory (subdirectory of configured dir with numeric name)
  • Cross-platform path handling: "/" if os.name == "posix" else "\\"
  • Language support in submit.py:lang_ids dict maps file extensions to Codeforces language IDs