Skip to content

Commit 15c171b

Browse files
Enhance README with badges and clearer descriptions
Updated README with improved descriptions and badges.
1 parent aa8183b commit 15c171b

File tree

1 file changed

+19
-16
lines changed

1 file changed

+19
-16
lines changed

README.md

Lines changed: 19 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,33 @@
1-
# Py-libbpf
1+
<img src="https://github.com/user-attachments/assets/9e873d60-a834-4411-bc0c-361b14502f8b" alt="pylibbpf" width="450">
22
<p align="center">
3-
<a href="https://www.python.org/downloads/release/python-3080/"><img src="https://img.shields.io/badge/python-3.8-blue.svg"></a>
4-
<a href="https://pypi.org/project/pylibbpf"><img src="https://badge.fury.io/py/pylibbpf.svg"></a>
3+
<!-- PyPI -->
4+
<a href="https://www.python.org/downloads/release/python-3080/"><img src="https://img.shields.io/badge/python-3.8-blue.svg"></a>
5+
<a href="https://pypi.org/project/pylibbpf"><img src="https://badge.fury.io/py/pylibbpf.svg"></a>
6+
<!-- <a href="https://pypi.org/project/pythonbpf/"><img src="https://img.shields.io/pypi/status/pythonbpf" alt="PyPI Status"></a> -->
7+
<a href="https://pepy.tech/project/pylibbpf"><img src="https://pepy.tech/badge/pylibbpf" alt="Downloads"></a>
8+
<!-- Build & CI -->
9+
<a href="https://github.com/pythonbpf/pylibbpf/actions"><img src="https://github.com/pythonbpf/pylibbpf/actions/workflows/wheels.yml/badge.svg" alt="Build Status"></a>
10+
<!-- Meta -->
11+
<a href="https://github.com/pythonbpf/pylibbpf/blob/master/LICENSE"><img src="https://img.shields.io/github/license/pythonbpf/pylibbpf" alt="License"></a>
512
</p>
6-
This library provides Python bindings for libbpf on Linux to make loading of eBPF object files easier. This is meant to
7-
be used along with `pythonbpf`, the eBPF Python DSL compiler. This library makes it possible to attach these programs to
8-
events in the kernel right from inside Python.
913

10-
# IN DEVELOPMENT. DO NOT USE.
14+
This library provides Python bindings for **libbpf** on Linux, making it easier to load eBPF object files. It is designed to be used together with [PythonBPF](https://github.com/pythonbpf/python-bpf), the eBPF compiler for Python. With these bindings, you can attach eBPF programs to kernel events directly from Python.
15+
All programs written with this are to be run with a `sudo` Python interpreter.
1116

12-
## Prerequisites
17+
> **Note**: This project is under active development and not ready for production use.
18+
19+
## Dependencies
1320

1421
* A compiler with C++11 support
1522
* Pip 10+ or CMake >= 4.1
1623
* Ninja or Pip 10+
1724

18-
1925
## Installation
26+
`pip install pylibbpf`
27+
28+
## Development
2029

21-
Just clone this repository and pip install. Note the `--recursive` option which is
30+
Clone this repository and pip install. Note the `--recursive` option which is
2231
needed for the pybind11 submodule:
2332

2433
```bash
@@ -30,11 +39,5 @@ pip install .
3039
With the `setup.py` file included in this example, the `pip install` command will
3140
invoke CMake and build the pybind11 module as specified in `CMakeLists.txt`.
3241

33-
## Development
34-
Do this before running to make sure Python can manipulate bpf programs without sudo
35-
```bash
36-
sudo setcap cap_bpf,cap_sys_admin+ep /usr/bin/python3.12
37-
```
38-
3942
## Building the documentation
4043
The documentation here is still boilerplate.

0 commit comments

Comments
 (0)