History

Vincenzo Palazzo dd7393e6bb proto: update the bitstring dep This is an alternative version to [1] that update only the necessary information around our codebase to upgrade the bitstring package. This upgrade is necessary for the user of our package that will find conflics in their codebase about packages version. [1] https://github.com/ElementsProject/lightning/pull/6585 Co-Developed-by: @dni Chanegelog-None Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>		2023-10-24 11:49:32 +10:30
..
examples	pyln-proto: fix port typo in example script	2022-03-11 16:42:45 +10:30
pyln/proto	proto: update the bitstring dep	2023-10-24 11:49:32 +10:30
tests	signed types: add handlers for signed types	2023-07-13 19:34:47 +09:30
.gitignore	pyln: Update the makefile to use poetry for publishing	2022-05-01 14:22:49 +09:30
Makefile	pyln: use poetry version, add target to check version, use poetry publish.	2022-09-22 11:41:11 +02:00
README.md	docs: fix contrib/ docs	2022-07-17 21:40:01 +09:30
pyproject.toml	proto: update the bitstring dep	2023-10-24 11:49:32 +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 Core Lightning source code and installing into your python3 environment:

git clone https://github.com/ElementsProject/lightning.git
cd lightning/contrib/pyln-proto
poetry install

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.