You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
CI: Install uv in CLN Python package deps jobs
Update shebang to use uv run --script and add inline metadata block
Update README with both install methods
Copy file name to clipboardExpand all lines: prometheus/README.md
+43Lines changed: 43 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,3 +16,46 @@ Exposed variables include:
16
16
HTLCs are currently attached to the channel
17
17
-`funds`: satoshis in on-chain outputs, satoshis allocated to channels and
18
18
total sum (may be inaccurate during channel resolution).
19
+
20
+
## Installation
21
+
### Using uv (recommended)
22
+
* Install `uv` and make the plugin executable
23
+
```
24
+
pip install --upgrade pip uv
25
+
chmod a+x prometheus.py
26
+
```
27
+
Then you can add _just that file_ to your Core Lightning plugins directory. The plugin should start automatically and its dependencies will be installed on-the-fly when the node comes up.
28
+
29
+
### Using poetry (legacy)
30
+
If you don't want to use `uv`, you can still use `poetry`. You need to update the shebang line to point the OS at the correct interpreter (`python3`) though:
31
+
```
32
+
sed -i 's#-S uv run --script#python3#' prometheus.py
33
+
```
34
+
35
+
Then install `poetry` and build the package:
36
+
```
37
+
pip install --upgrade pip poetry
38
+
poetry install --only main
39
+
```
40
+
41
+
This is an example snippet for installing the plugin's dependencies and cleaning up afterwards:
0 commit comments