History

Sergi Delgado Segura 9de5f438c4 pyln: Adds type annotations to zbase32 functions		2020-10-22 13:56:57 +02:00
..
examples	pyln: Split pylightning into multiple pyln modules	2019-09-30 13:27:37 +02:00
pyln/proto	pyln: Adds type annotations to zbase32 functions	2020-10-22 13:56:57 +02:00
tests	pyln: Moves old zbase32 test from primitives	2020-10-22 13:56:57 +02:00
Makefile	pyln: Parametrize and unify Makefiles for pyln package	2020-09-28 09:19:46 +09:30
README.md	pyln: Split pylightning into multiple pyln modules	2019-09-30 13:27:37 +02:00
requirements.txt	pyln.proto.message: use BufferedIOBase instead of bytes for binary ops.	2020-06-12 15:35:35 +02:00
setup.py	pyln: Bump proto version to match pyln-bolt*	2020-09-10 20:01:41 +09: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.