History

Christian Decker c673c092dc py: Update the PyPI job to use poetry and correct versions Let's use poetry when we already use it for everything else. Changelog-None		2022-03-30 06:12:40 +10:30
..
examples	pyln-proto: fix port typo in example script	2022-03-11 16:42:45 +10:30
pyln/proto	pyln: Fix the pyln-proto version and migrate to PEP 517 (poetry)	2022-03-08 05:00:36 +10:30
tests	pytest: Remove onion test vectors containing legacy onions.	2022-03-18 09:20:11 +10:30
.gitignore	pyln: Fix the pyln-proto version and migrate to PEP 517 (poetry)	2022-03-08 05:00:36 +10:30
Makefile	pyln: Add E741 as excluded flake warnings	2021-07-30 19:17:47 +02:00
README.md	pyln: Split pylightning into multiple pyln modules	2019-09-30 13:27:37 +02:00
pyproject.toml	py: Update the PyPI job to use poetry and correct versions	2022-03-30 06:12:40 +10:30

README.md

pyln-proto: Lightning Network protocol implementation

This package implements some of the Lightning Network protocol in pure python. It is intended for protocol testing and some minor tooling only. It is not deemed secure enough to handle any amount of real funds (you have been warned!).

Installation

pyln-proto is available on pip:

pip install pyln-proto

Alternatively you can also install the development version to get access to currently unreleased features by checking out the c-lightning source code and installing into your python3 environment:

git clone https://github.com/ElementsProject/lightning.git
cd lightning/contrib/pyln-proto
python3 setup.py develop

This will add links to the library into your environment so changing the checked out source code will also result in the environment picking up these changes. Notice however that unreleased versions may change API without warning, so test thoroughly with the released version.