mirror of
https://github.com/ElementsProject/lightning.git
synced 2024-11-19 18:11:28 +01:00
3418e59d76
This is the first step to transition to a better organized python module structure. Sadly we can't reuse the `pylightning` module as a namespace module since having importable things in the top level of the namespace is not allowed in any of the namespace variants [1], hence we just switch over to the `pyln` namespace. The code the was under `lightning` will now be reachable under `pyln.client` and we add the `pyln.proto` module for all the things that are independent of talking to lightningd and can be used for protocol testing. [1] https://packaging.python.org/guides/packaging-namespace-packages/ Signed-off-by: Christian Decker <decker.christian@gmail.com>
31 lines
983 B
Markdown
31 lines
983 B
Markdown
# 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:
|
|
|
|
```bash
|
|
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.
|