diff options
| author | diogo464 <[email protected]> | 2025-06-29 15:11:17 +0100 |
|---|---|---|
| committer | diogo464 <[email protected]> | 2025-06-29 15:11:17 +0100 |
| commit | 5f81d08687494277ffe5f72b86d1c1b3c9341d9a (patch) | |
| tree | 1e3fa417e10416287a98c7583b37b311b40e6cd7 /README.md | |
| parent | bb76625240ba60a1fc0d80d80ae0aefd56c66682 (diff) | |
Convert from Rust to Python project with uv support
Remove Rust-related files (Cargo.toml, Cargo.lock, src/, target/) and restructure as Python project using uv for dependency management. Update project structure to match nova-oar-mcp style with pyproject.toml, .python-version, and proper Python packaging conventions.
🤖 Generated with [Claude Code](https://claude.ai/code)
Co-Authored-By: Claude <[email protected]>
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..e562707 --- /dev/null +++ b/README.md | |||
| @@ -0,0 +1,48 @@ | |||
| 1 | # OAR P2P Network Management | ||
| 2 | |||
| 3 | A Python tool for managing P2P network configurations in OAR cluster environments with configurable latency matrices. | ||
| 4 | |||
| 5 | ## Installation | ||
| 6 | |||
| 7 | This project uses [uv](https://docs.astral.sh/uv/) for dependency management. | ||
| 8 | |||
| 9 | ```bash | ||
| 10 | # Install uv if you haven't already | ||
| 11 | curl -LsSf https://astral.sh/uv/install.sh | sh | ||
| 12 | |||
| 13 | # Run the tool directly | ||
| 14 | uv run oar_p2p.py --help | ||
| 15 | ``` | ||
| 16 | |||
| 17 | ## Usage | ||
| 18 | |||
| 19 | The tool provides three main commands: | ||
| 20 | |||
| 21 | ### Setup Network (`up`) | ||
| 22 | Configure network interfaces and apply latency settings: | ||
| 23 | ```bash | ||
| 24 | uv run oar_p2p.py up <job_id> <addresses> <latency_matrix_file> | ||
| 25 | ``` | ||
| 26 | |||
| 27 | ### Cleanup Network (`down`) | ||
| 28 | Remove network configurations: | ||
| 29 | ```bash | ||
| 30 | uv run oar_p2p.py down <job_id> | ||
| 31 | ``` | ||
| 32 | |||
| 33 | ### Generate Configurations (`configurations`) | ||
| 34 | Preview the network configurations that would be applied: | ||
| 35 | ```bash | ||
| 36 | uv run oar_p2p.py configurations <job_id> <addresses> <latency_matrix_file> | ||
| 37 | ``` | ||
| 38 | |||
| 39 | ## Requirements | ||
| 40 | |||
| 41 | - Python 3.12+ | ||
| 42 | - Access to OAR cluster environment | ||
| 43 | - Docker with networking privileges | ||
| 44 | - Custom networking container: `ghcr.io/diogo464/oar-p2p-networking:latest` | ||
| 45 | |||
| 46 | ## License | ||
| 47 | |||
| 48 | MIT \ No newline at end of file | ||
