lightningames / pylnbits Goto Github PK

View Code? Open in Web Editor NEW

11.0 1.0 10.0 6.24 MB

python package for Lnbits API

License: MIT License

Python 100.00%

lightning lnbits api-client python3 library package python bitcoin payments hacktoberfest

pylnbits's Introduction

pylnbits

Pull Requests are Welcome!

An asyncio/aiohttp python library of methods for accessing lnbits API or your own install. For use when building front end or app layer projects with lnbits.

Read the Docs

https://lightningames.github.io/pylnbits/

See also Powered-by-LNBits for more resources. This project, pylnbits, is also listed on the Powered by LNbits wiki.

Updating the docs

See mkdocs for guidance on how to update docs and also https://github.com/lightningames/pylnbits/blob/main/mkdocs.yml

deploy to github pages:

https://www.mkdocs.org/user-guide/deploying-your-docs/#github-pages

mkdocs gh-deploy

Getting Started

With Poetry

poetry version at least 1.4.2

git clone https://github.com/lightningames/pylnbits
poetry install

With Virtual Env

version at least python3.8

git clone https://github.com/lightningames/pylnbits
cd pylnbits
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -e .

Copy config_sample.yml to config.yml and update the variables with your lnbits install:

lnbits_url: "https://lnbits.com"
in_key: "fill in with your Invoice Key here"
admin_key: "fill with your admin key here "

Run tests in tests directory to see sample usage.

NOTE: This is experimental software. The only modules & Extensions covered presently are:

User Wallet
User Manager
LNURLp
LNURLw
LndHub
Invoices

If you would like to contribute, please feel free to make a pull request.

Library Installation

current release is 0.0.8, tested to LNBits 0.10.9

pip install pylnbits

https://pypi.org/project/pylnbits/

Other

Check linting and formatting pre-commit run -a

Build for distribution python3 setup.py build

Also see Tutorials for build to release on PyPi for uploading distribution archives https://packaging.python.org/en/latest/tutorials/packaging-projects/

Run Examples

See the tests directory for working examples

pylnbits's People

Contributors

Stargazers

Watchers

Forkers

bitkarrot cliffc2 pedrambk davisv7 bitwalt felixfrei eriknewland brutusbondbtc bitc0indad fenixlibertas

pylnbits's Issues

Update Docs to match latest release 0.0.6

See mkdocs for guidance on how to update docs and also https://github.com/lightningames/pylnbits/blob/main/mkdocs.yml

Test against LNBits latest release

test all modules against LNBits latest release 0.12.5 or latest and make any updates if necessary

Update Docs Examples

Update docs to provide examples for : Sample code for lnurlw, user manager and userwallet.

you can model the docs off the section that is already documented called "Sample code for lnurlp"
The sample code is all in the test files.
The test code need to properly formatted and confirmed that they work.

https://github.com/lightningames/pylnbits#updating-the-docs

Create Automated releases to PyPi

See article on how to do automated PyPi Releases and create it here in this repo as a git action on release tag

https://www.caktusgroup.com/blog/2021/02/11/automating-pypi-releases/

0.0.7 Release build

Tentative date: August 1, 2023, please get all of your PRs in before then!
Roll in all new changes and updates and release to pypi

maintenance

test to make sure that the current release is compatible with latest LNBits release.
update pypy release

0.0.9 Release Build

Tentative date: April 1, 2023, please get all of your PRs in before then!
Welcome to new contributors
remember to merge in this pr before release #97

convert test to real pytest

convert tests in the test folder into real pytests (https://pytest.org)

Convert userwallet to a pytest

Convert test_userwallet.py to a pytest

https://github.com/lightningames/pylnbits/blob/main/tests/test_userwallet.py

Div compatibility fix

1.) get_url returns the dict after extracting the json attribute therefore this fails in the UserWallet class.

2.) /api/v1/payments/decode expects the body as json

Add more modules to pylnbits (ongoing task)

Add to the pylnbits SDK by expanding to more endpoints from the Swagger API

See LNBits docs

Also see pylnbits Docs, docs contributors are also welcome

This is open to first time contributors

New function to pay LNURLP

0.0.8 Release Build

Tentative date: December 1, 2023, please get all of your PRs in before then!
Welcome to new contributors

Update docs for new pytests

After tests are converted in real pytests in #14
update the docs accordingly. See docs folder at https://github.com/lightningames/pylnbits/tree/main/docs

and actual docs at: https://lightningames.github.io/pylnbits/

Convert to Project setup to poetry

convert setup to poetry as requirements are getting a little difficult to manage down stream