Skip to content

Commit 3cfa373

Browse files
committed
Add pyproject metadata and update README
Add build-system section and setuptools package discovery in pyproject.toml. Mark the README Installation section as temporary and document using `uv sync` or the `uv pip install -e .` interface.
1 parent d341f4b commit 3cfa373

2 files changed

Lines changed: 12 additions & 2 deletions

File tree

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This project implements various Byzantine-resilient Gradient Aggregation Rules (
1313
- **Extensible**: Easy to add new aggregation rules or attacks.
1414
- **High-performance**: Optional native C++ backend for Krum.
1515

16-
## Installation
16+
## Installation (temporary)
1717

1818
This project uses `uv` for dependency management.
1919

@@ -22,7 +22,10 @@ This project uses `uv` for dependency management.
2222
git clone https://github.com/your-username/krum.git
2323
cd krum
2424

25-
# Install dependencies
25+
# Install dependencies (using uv's native command — recommended)
26+
uv sync
27+
28+
# Or, using the pip-compatible interface
2629
uv pip install -e .
2730
```
2831

pyproject.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
[build-system]
2+
requires = ["setuptools>=61.0"]
3+
build-backend = "setuptools.build_meta"
4+
5+
[tool.setuptools.packages.find]
6+
include = ["aggregators*", "attacks*", "experiments*", "native*", "tools*"]
7+
18
[project]
29
name = "krum"
310
version = "0.1.0"

0 commit comments

Comments
 (0)