Metadata-Version: 2.5
Name: netbench-ci
Version: 0.1.0
Summary: Reproducible XDP/eBPF performance regression testing for Linux
Author: Ali Raza Arain
License-Expression: Apache-2.0
Requires-Python: >=3.11
Description-Content-Type: text/markdown

# NetBench CI

**Reproducible XDP/eBPF performance regression testing for Linux.**

NetBench CI is an early-stage open-source project designed to make
Linux networking benchmarks repeatable and help detect performance
regressions in XDP/eBPF workloads.

## Current Status

NetBench CI is under active development.

The initial release provides a basic environment diagnostic command.
Benchmark execution, baseline comparison, and CI integration are
planned features and are not yet implemented.

## Requirements

- Python 3.11 or newer
- Linux recommended for XDP/eBPF development
- Clang, iproute2, and bpftool for future benchmarking functionality

## Installation

```bash
python -m pip install netbench-ci
```
## Usage

Display the installed version:

```bash
netbench --version
```

Check your environment:

```bash
netbench doctor
```

## Planned Features

- XDP/eBPF benchmark orchestration
- Repeatable performance measurements
- Baseline comparison and regression detection
- JSON benchmark reports
- CI pipeline integration
- Linux kernel and environment metadata

## Development

Clone the repository and install the package in editable mode:

```bash
git clone https://github.com/Ali-Raza-Arain/netbench-ci
cd netbench-ci
python -m pip install -e .
```

## License

Apache-2.0 License
