https://github.com/lightningames/pylnbits
python package for Lnbits API
https://github.com/lightningames/pylnbits
api-client bitcoin hacktoberfest library lightning lnbits package payments python python3
Last synced: 3 months ago
JSON representation
python package for Lnbits API
- Host: GitHub
- URL: https://github.com/lightningames/pylnbits
- Owner: lightningames
- License: mit
- Created: 2021-05-17T22:42:42.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-26T03:33:10.000Z (about 1 year ago)
- Last Synced: 2025-12-16T09:15:17.087Z (6 months ago)
- Topics: api-client, bitcoin, hacktoberfest, library, lightning, lnbits, package, payments, python, python3
- Language: Python
- Homepage:
- Size: 6.17 MB
- Stars: 13
- Watchers: 1
- Forks: 12
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# pylnbits
Pull Requests are Welcome!
An asyncio/aiohttp python library of methods for accessing [lnbits](https://github.com/lnbits/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](https://github.com/lnbits/lnbits/wiki/Powered-by-LNbits) for more resources.
This project, [pylnbits](https://github.com/lightningames/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
- Split Payments
If you would like to contribute, please feel free to make a pull request.
## Library Installation
current release is 0.0.9, tested to LNBits 0.11.2
```
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/
## Contributors
Run Examples
See the `tests` directory for working examples