Skip to content

Add universal uv-based installer #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
SeaCelo wants to merge 1 commit into from
Closed

Add universal uv-based installer #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions scripts/QUICK_INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Quick install

Pre-req: **git** installed. Nothing else.

## macOS / Linux

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/EAPD-DRB/OG-ETH/main/scripts/install.sh)" _ --repo og-eth
```

## Windows (PowerShell)

```powershell
& ([scriptblock]::Create((irm https://raw.githubusercontent.com/EAPD-DRB/OG-ETH/main/scripts/install.ps1))) -Repo og-eth
```

## Skip the prompts

```bash
# macOS / Linux -- clones to ~/Projects/OG-ETH
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/EAPD-DRB/OG-ETH/main/scripts/install.sh)" _ --repo og-eth --dest ~/Projects --yes
```

```powershell
# Windows -- clones to C:\Users\<you>\Projects\OG-ETH
& ([scriptblock]::Create((irm https://raw.githubusercontent.com/EAPD-DRB/OG-ETH/main/scripts/install.ps1))) -Repo og-eth -Dest C:\Users\$env:USERNAME\Projects -Yes
```

## After install

Activate the venv and you're set:

```bash
# macOS / Linux
cd <destination>
source .venv/bin/activate
python -W ignore -c "import ogeth; print(ogeth.__version__)"
```

```powershell
# Windows
cd <destination>
.\.venv\Scripts\Activate.ps1
python -W ignore -c "import ogeth; print(ogeth.__version__)"
```

## Manual download (inspect before running)

```bash
# macOS / Linux
curl -fsSL https://raw.githubusercontent.com/EAPD-DRB/OG-ETH/main/scripts/install.sh -o install.sh
less install.sh # inspect
bash install.sh --repo og-eth
```

```powershell
# Windows
Invoke-WebRequest -UseBasicParsing -Uri https://raw.githubusercontent.com/EAPD-DRB/OG-ETH/main/scripts/install.ps1 -OutFile install.ps1
notepad install.ps1 # inspect
powershell -ExecutionPolicy Bypass -File .\install.ps1 -Repo og-eth
```

The installer is universal — it works for any uv-migrated OG country repo. Run it without `--repo` / `-Repo` to pick from a menu instead of going straight to OG-ETH.
Loading
Loading