Ripple JSON-RPC API and Data API wrapper for Python
Project description
Available on PyPi
Installation
To install the package from PyPi run the following command
pip install python-ripple-lib
If you want to install package from this repo, use setup.py
python setup.py install
If you want to install package just for development purposes, use another command
python setup.py develop
This command creates symlinks to package files instead of copying it to package directory
JSON-RPC Methods
from ripple_api import RippleRPCClient
# module supports authentication as well
rpc = RippleRPCClient('http://s1.ripple.com:51234/', username='<username>', password='<password>')
account_info = rpc.account_info('r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59')
Data API Methods
from ripple_api import RippleDataAPIClient
api = RippleDataAPIClient('https://data.ripple.com')
identifier = '3170DA37CE2B7F045F889594CBC323D88686D2E90E8FFD2BBCD9BAD12E416DB5'
query_params = dict(transactions='true')
ledger_info = api.get_ledger(ledger_identifier=identifier, **query_params)
from ripple_api import RippleDataAPIClient
from pprint import pprint
api = RippleDataAPIClient('https://data.ripple.com')
# to get name of a specific transaction type please refer to this link:
# https://developers.ripple.com/transaction-types.html
query_params = dict(type="Payment")
txs = api.get_transactions(**query_params)
pprint(txs)
Additional methods
Send XRP from address tp address via Account instance:
from ripple_api import Account
taker = 'rYuHe4VogMzYmvHpSsgGxRH97UvqumgER'
issuer = 'rMEmLrfkfooLjdkerU5TKTcAVpfy9fpSxt'
seed = '<account_seed>'
account = Account('http://localhost:5005', issuer, seed)
tx_info = account.send_xrp(issuer=issuer, taker=taker, secret=seed, amount=10)
Contributing
Fork this project
Clone it locally
Add your changes
Run tests:
make test
or
python -m unittest -v
If tests are successful and everything is OK, commit to your local fork
Submit a pull request to this repo
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file python-ripple-lib-1.0.11.tar.gz
.
File metadata
- Download URL: python-ripple-lib-1.0.11.tar.gz
- Upload date:
- Size: 18.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 01c8cf720d889f4d4629ad8a873bd4b357b23b191bb36680545a14be0646239d |
|
MD5 | 5cc594fc54d605ad01b0e687d1726cfc |
|
BLAKE2b-256 | d04b0be8c4286ff5f69a479ac797bd2c27277a4a7fe283584c842722f2a85fb9 |
File details
Details for the file python_ripple_lib-1.0.11-py3-none-any.whl
.
File metadata
- Download URL: python_ripple_lib-1.0.11-py3-none-any.whl
- Upload date:
- Size: 19.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.3.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.7.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ed395a40635ab30efc0e47bb7264ba102d9e3f2f305d79bf893e4d4e754698af |
|
MD5 | 114a42e9386cd1d7d22c7df9aec69c10 |
|
BLAKE2b-256 | cc33a8033ff451abf83841a39ff2c21ed1f466cbe8148e697bbccdb48dad525e |