From 4d4f5d0af51481dcf6755aed8c7c46dde90366b1 Mon Sep 17 00:00:00 2001 From: Tyler Goodlet Date: Tue, 10 Jun 2025 14:22:58 -0400 Subject: [PATCH] Fix readme to `uv sync`.. link to astral docs --- README.rst | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 5e8f29bc..153d260b 100644 --- a/README.rst +++ b/README.rst @@ -88,15 +88,23 @@ a sane install with `uv` ************************ bc why install with `python` when you can faster with `rust` :: - uv lock + uv sync -with all GUI support as well:: + # ^ astral's docs, + # https://docs.astral.sh/uv/concepts/projects/sync/ - uv lock --extra uis +include all GUIs :: -AND with all dev (hacking) tools:: + uv sync --extra uis - uv lock --dev --extra uis +AND with all our hacking tools:: + + uv sync --dev --extra uis + + +Ensure you can run the root-daemon:: + + uv run pikerd [-l info --pdb] hacky install on nixos @@ -111,7 +119,18 @@ start a chart ************* run a realtime OHLCV chart stand-alone:: - piker -l info chart btcusdt.spot.binance xmrusdt.spot.kraken + [uv run] piker -l info chart btcusdt.spot.binance xmrusdt.spot.kraken + + # ^^^ iff you haven't activated the py-env, + # - https://docs.astral.sh/uv/concepts/projects/run/ + # + # in order to create an explicit virt-env see, + # - https://docs.astral.sh/uv/concepts/projects/layout/#the-project-environment + # - https://docs.astral.sh/uv/pip/environments/ + # + # use $UV_PROJECT_ENVIRONMENT to select any non-`.venv/` + # as the venv sudir in the repo's root. + # - https://docs.astral.sh/uv/reference/environment/#uv_project_environment this runs a chart UI (with 1m sampled OHLCV) and shows 2 spot markets from 2 diff cexes overlayed on the same graph. Use of `piker` without first starting