mirror of https://github.com/ElementsProject/lightning.git synced 2024-11-19 09:54:16 +01:00

History

Greg Sanders 3b56e90a13 Turn on logging for key topics in bitcoind for black box tests		2022-12-22 12:05:01 +01:00
..
pyln/testing	Turn on logging for key topics in bitcoind for black box tests	2022-12-22 12:05:01 +01:00
tests	pyln-testing: Add a dummy test to check functionality	2020-08-30 20:03:42 +02:00
.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
pyproject.toml	pyln: Bump versions	2022-11-11 10:37:37 +01:00
README.md	docs: fix contrib/ docs	2022-07-17 21:40:01 +09:30

README.md

pyln-testing: A library to write tests against Core Lightning

This library implements a number of utilities that help building tests for Core Lightning nodes. In particular it provides a number of pytest fixtures that allow the management of a test network of a given topology and then execute a test scenarion.

pyln-testing is used by Core Lightning for its internal tests, and by the community plugin directory to exercise the plugins.

Installation

pyln-testing is available on pip:

pip install pyln-testing

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-testing
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.