From 03f65a031b4364629efbd93d2d4095c9898fe9fe Mon Sep 17 00:00:00 2001 From: Chris Arderne Date: Thu, 22 Aug 2024 13:23:20 +0100 Subject: [PATCH] add rye install instructions --- README.md | 6 ++++++ docs/quickstart.md | 8 ++++++++ una/types.py | 3 --- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d8aedab..43efa1c 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,12 @@ You can see examples for each of the two styles here: This will give you a quick view of how this all works. A `packages` style will be used by default, as it is probably more familiar to most. +First install Rye: +```bash +curl -sSf https://rye.astral.sh/get | bash +``` + +And start your workspace: ```bash rye init unarepo # choose another name if you prefer cd unarepo diff --git a/docs/quickstart.md b/docs/quickstart.md index 6d00495..e28fd9c 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -2,6 +2,12 @@ This will give you a quick view of how this all works. A `packages` style will be used by default, as it is probably more familiar to most. +First install Rye: +```bash +curl -sSf https://rye.astral.sh/get | bash +``` + +And start your workspace: ```bash rye init unarepo # choose another name if you prefer cd unarepo @@ -69,4 +75,6 @@ docker run --rm -it unarepo-printer python -c 'from unarepo.printer import run; ## Example After running through the steps above, the result will be similar to the Projects style example repo: + - [una-example-packages](https://github.com/carderne/una-example-packages) +- [una-example-modules](https://github.com/carderne/una-example-modules) diff --git a/una/types.py b/una/types.py index 5d70084..b707b80 100644 --- a/una/types.py +++ b/una/types.py @@ -22,9 +22,6 @@ class OrgImports: class Include: src: str dst: str - # path: str - # include: str - # root: str @dataclass(frozen=True)