Metadata-Version: 2.4
Name: Velocicode
Version: 0.9.1
Summary: A CLI tool for programming language speed benchmarks
Author-email: Zhaoyang Li <zhaoyangli6969@gmail.com>
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pyyaml
Requires-Dist: rich>=13.0.0
Requires-Dist: psutil
Requires-Dist: py-cpuinfo
Dynamic: license-file

# Velocicode 🚀

**Velocicode** is a high-performance command-line tool for benchmarking programming language speeds. It allows you to run standard algorithms across multiple languages and compare their execution time with professional, interactive reports.

## Features ✨

- **Multi-Language Support**: Benchmarks **Python**, **C++**, **Rust**, **Go**, **JavaScript** (Node.js), **Java**, and **C#** (.NET).
- **Standard Algorithms**:
  - `fibonacci` (Recursion intensity)
  - `matrix_mul` (Floating point & Cache)
  - `quicksort` (Memory & Sorting)
  - `primes` (Sieve of Eratosthenes)
  - `string_concat` (String Optimization) 🧵
  - `json_parse` (Data Processing) 📄
  - `regex_redact` (Text Processing) 🔍
  - **New in v0.9.0**:
    - `async_io` (Async Task Overhead) ⏱️
    - `sqlite_ops` (Database Insert/Select) 💾
    - `http_server` (HTTP Throughput) 🌐
- **Smart Execution**:
  - **System Info**: Auto-detects your CPU, RAM, and OS.
  - **Memory Benchmarking (New)**: Tracks **Peak RAM** usage for every run. 🧠
  - **Dependency Check**: Automatically checks for compilers and skips missing languages.
- **Premium UI**:
  - Beautiful terminal output using the **Rich** library.
  - Rankings with Medals (🥇 🥈 🥉).
  - Relative Speed comparisons (e.g., `1.00x` vs `45.9x`).
- **Data Export**:
  - **JSON**: Raw data export for analysis.
  - **HTML**: Interactive reports with **Charts** for presentations.

## Installation

```bash
pip install velocicode
```

To install compilers for all supported languages (Python, C++, Rust, Go, Node.js, Java, .NET), run:

```bash
velocicode deps
```

This will print the exact install command for your OS (Ubuntu, Fedora, macOS, Windows).

## Usage

### 1. Run Benchmarks

Run all benchmarks with default settings:

```bash
velocicode run
```

The tool will display your system information and check if you have the necessary compilers. If some are missing, it will ask if you want to proceed with the available ones.

Filter by specific algorithm or language:

```bash
# Run only Matrix Multiplication in Rust and Go
velocicode run --filter-algo matrix_mul --filter-lang rust,go
```

### 2. Generate Reports 📊

Export results to JSON or generate a visual HTML report:

```bash
velocicode run --html report.html --json results.json
```

Open `report.html` in your browser to see interactive bar charts!

### 3. Check Compilers

Velocicode relies on system compilers. Check what you have installed:

```bash
velocicode check
```

## Requirements

> [!IMPORTANT]
> This tool requires external compilers. `pip` installs the runner, but you need the languages installed:

- **Python 3.7+**
- `g++` (for C++)
- `rustc` (for Rust)
- `go` (for Go)
- `node` (for JavaScript)
- `javac` (for Java - **JDK required**, e.g. `java-latest-openjdk-devel`)
- `dotnet` (for C#)

## License

MIT
