core-lightning/contrib/pyln-proto/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:

```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.
pyln: Split pylightning into multiple pyln modules 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> 2019-07-23 15:26:28 +02:00			`# 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`
doc: update c-lightning to Core Lightning almost everywhere. Mostly comments and docs: some places are actually paths, which I have avoided changing. We may migrate them slowly, particularly when they're user-visible. Signed-off-by: Rusty Russell <rusty@rustcorp.com.au> 2022-04-06 07:09:48 +02:00			`currently unreleased features by checking out the Core Lightning source code and`
pyln: Split pylightning into multiple pyln modules 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> 2019-07-23 15:26:28 +02:00			`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.`