lightningames / pylnbits Goto Github PK

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

• 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

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/

• 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

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/

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

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

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

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

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

Convert test_userwallet.py to a pytest

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

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

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

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