rbx-cp 0.34.1

No project description provided

The go-to CLI tool for programming competitions setters.

Table of Contents

• Overview
• Features
• Documentation
• Contributing
  • Prerequisites
  • Getting Started
  • Common Tasks
  • Code Style
  • Submitting Changes
• License

---

Overview

rbx is a CLI tool that empowers setters from the competitive programming community.

A flexible setting tool, as powerful as Polygon, right on your terminal.

---

Features

• 🧱 Structure: describe your problem or contest structure with the use of YAML configuration files.
• 🤖 Generation: provides a simple way to describe your whole testset, including both manually added and generated testcases.
• 🔨 Testing: provides commands for automatically running correct and incorrect solutions against the testcases of your problem, automatically judging whether the verdict was as expected or not.
• ✅ Verify: checks if your testcases and solutions are strictly conformant with the use of validators and unit tests.
• 📝 Statements: provides tooling for writing and building statements, also ensuring they're easily synchronized with your testset.
• 📤 Package: provides a single command for packaging your problems for use in your preferred judge system.

---

Documentation

You can read the docs here.

---

Contributing

Prerequisites

• Python 3.9+
• uv — package manager
• mise — task runner

Getting Started

git clone https://github.com/rsalesc/rbx.git
cd rbx
mise run sync
pre-commit install

Common Tasks

All development commands are run through mise:

Command	Description
mise run sync	Install/sync all dependencies
mise run lock	Regenerate uv.lock
mise run lint	Run linter
mise run lint-fix	Run linter with auto-fix
mise run format	Format code
mise run format-check	Check formatting without changes
mise run check	Run all checks (lint + format)
mise run test	Run tests (excludes e2e/slow/docker)
mise run test-cov	Run tests with coverage
mise run test-e2e	Run e2e tests
mise run build	Clean build the package

Run mise tasks to see all available tasks.

Code Style

• Single quotes for strings
• Absolute imports only — no relative imports
• Conventional Commits — enforced by pre-commit hook

All style rules are enforced automatically by pre-commit hooks (ruff check, ruff format, commitizen).

Submitting Changes

1. Create a branch from main
2. Make your changes
3. Run mise run check and mise run test
4. Commit using Conventional Commits format
5. Open a pull request

---

License

This project is protected under the Apache License 2.0 License. For more details, refer to the LICENSE file.

---

Return

---