Skip to content

Commit

Permalink
Flesh out contrib python dep installation instructions and add Nix se…
Browse files Browse the repository at this point in the history
…ction
  • Loading branch information
chrisguida committed Oct 7, 2024
1 parent 9b69e8b commit ea2ee4d
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions contrib/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,49 @@

## Installing

There are two ways to install the requirements:
- poetry
- nix

### Poetry
There are two ways to install poetry:
- pipx
- official installer

#### Pipx

```
# Install pipx
sudo apt update
sudo apt install pipx
pipx install poetry
```

#### [Or, click here for the official installer](https://python-poetry.org/docs/#installing-with-the-official-installer)

Once poetry is installed, install the Python dependencies:

```
# The following commands need to be run as the user who will be running
# the clboss utility commands (connecting to the CLN RPC port)
# Install poetry: https://python-poetry.org/docs/#installing-with-the-official-installer
# Install clboss contrib utilities
poetry shell
poetry install
```

### Nix
If you have nix, you can just do, from the project root:
```
nix-shell contrib-shell.nix
```

Then before running the commands below, be sure to do:

```
cd contrib/
```

## Running

```
Expand Down

0 comments on commit ea2ee4d

Please sign in to comment.