From 1b5507f5a40d75680d44c3f8faf581ff07b9f090 Mon Sep 17 00:00:00 2001 From: Faiz Surani Date: Tue, 3 Sep 2024 14:26:28 -0700 Subject: [PATCH] Bump to v0.8.1; update install instructions --- README.md | 15 ++++++++------- pyproject.toml | 2 +- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index dfefec0..0205d2d 100644 --- a/README.md +++ b/README.md @@ -12,21 +12,22 @@ RL is a Python library which provides several things: - A CLI (`rl`) interacting with [Sherlock](https://www.sherlock.stanford.edu/) less painful by automating Duo 2FA and providing useful primitives for working with SLURM jobs. -## Installation +## CLI Installation > NOTE: The below is only for a stable release of the Sherlock CLI. Docs for using the rest > of the library are forthcoming. -On your local machine: -```bash -pip install "rl @ git+https://github.com/ProbablyFaiz/rl.git@v0.4.2" -``` +The best way to install Sherlock is via `uv`, a fast Python installation/package manager. -On Sherlock, you should probably use the pre-compiled binary instead: +If you don't have it already (or have an old version), install `uv`: ```bash -wget "https://github.com/ProbablyFaiz/rl/releases/download/v0.4.2/rl" -O ~/.local/bin/rl +curl -LsSf https://astral.sh/uv/install.sh | sh ``` +Then, on both your local machine and Sherlock (or either one, if you just want some features): +``` +uv tool install "rl @ git+https://github.com/ProbablyFaiz/rl.git@latest" +``` ## Setup diff --git a/pyproject.toml b/pyproject.toml index 739f8fd..2258e12 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "rl" -version = "0.8.0" +version = "0.8.1" authors = [ { name = "Faiz Surani", email = "faiz@law.stanford.edu" }, { name = "Varun Magesh", email="vim@law.stanford.edu" }