=================
python-bitcoinrpc
=================
AuthServiceProxy is an improved version of python-jsonrpc.
It includes the following generic improvements:
* HTTP connections persist for the life of the AuthServiceProxy object
* sends protocol 'version', per JSON-RPC 1.1
* sends proper, incrementing 'id'
* uses standard Python json lib
* can optionally log all RPC calls and results
* JSON-2.0 batch support
It also includes the following bitcoin-specific details:
* sends Basic HTTP authentication headers
* parses all JSON numbers that look like floats as Decimal,
and serializes Decimal values to JSON-RPC connections.
Installation
============
1. change the first line of setup.py to point to the directory of your installation of python 2.*
2. run setup.py
Note: This will only install bitcoinrpc. If you also want to install jsonrpc to preserve
backwards compatibility, you have to replace 'bitcoinrpc' with 'jsonrpc' in setup.py and run it again.
Or simply install the library using pip::
pip install python-bitcoinrpc
Example
=======
.. code:: python
from bitcoinrpc.authproxy import AuthServiceProxy, JSONRPCException
# rpc_user and rpc_password are set in the bitcoin.conf file
rpc_connection = AuthServiceProxy("http://%s:%s@127.0.0.1:8332"%(rpc_user, rpc_password))
best_block_hash = rpc_connection.getbestblockhash()
print(rpc_connection.getblock(best_block_hash))
# batch support : print timestamps of blocks 0 to 99 in 2 RPC round-trips:
commands = [ [ "getblockhash", height] for height in range(100) ]
block_hashes = rpc_connection.batch_(commands)
blocks = rpc_connection.batch_([ [ "getblock", h ] for h in block_hashes ])
block_times = [ block["time"] for block in blocks ]
print(block_times)
Logging all RPC calls to stderr
===============================
.. code:: python
from bitcoinrpc.authproxy import AuthServiceProxy, JSONRPCException
import logging
logging.basicConfig()
logging.getLogger("BitcoinRPC").setLevel(logging.DEBUG)
rpc_connection = AuthServiceProxy("http://%s:%s@127.0.0.1:8332"%(rpc_user, rpc_password))
print(rpc_connection.getinfo())
Produces output on stderr like
DEBUG:BitcoinRPC:-1-> getinfo []
DEBUG:BitcoinRPC:<-1- {"connections": 8, ...etc }
Raw data
{
"_id": null,
"home_page": "http://www.github.com/jgarzik/python-bitcoinrpc",
"name": "python-bitcoinrpc",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Jeff Garzik",
"author_email": "<jgarzik@pobox.com>",
"download_url": "https://files.pythonhosted.org/packages/71/eb/80313654302a7f3ba2fa3a8ea9e4c65f910b353112df8da77e4974978665/python-bitcoinrpc-1.0.tar.gz",
"platform": "UNKNOWN",
"description": "=================\npython-bitcoinrpc\n=================\n\nAuthServiceProxy is an improved version of python-jsonrpc.\n\nIt includes the following generic improvements:\n\n* HTTP connections persist for the life of the AuthServiceProxy object\n* sends protocol 'version', per JSON-RPC 1.1\n* sends proper, incrementing 'id'\n* uses standard Python json lib\n* can optionally log all RPC calls and results\n* JSON-2.0 batch support\n\nIt also includes the following bitcoin-specific details:\n\n* sends Basic HTTP authentication headers\n* parses all JSON numbers that look like floats as Decimal,\n and serializes Decimal values to JSON-RPC connections.\n\nInstallation\n============\n\n1. change the first line of setup.py to point to the directory of your installation of python 2.*\n2. run setup.py\n\nNote: This will only install bitcoinrpc. If you also want to install jsonrpc to preserve \nbackwards compatibility, you have to replace 'bitcoinrpc' with 'jsonrpc' in setup.py and run it again.\n\nOr simply install the library using pip::\n\n pip install python-bitcoinrpc\n\nExample\n=======\n.. code:: python\n\n from bitcoinrpc.authproxy import AuthServiceProxy, JSONRPCException\n\n # rpc_user and rpc_password are set in the bitcoin.conf file\n rpc_connection = AuthServiceProxy(\"http://%s:%s@127.0.0.1:8332\"%(rpc_user, rpc_password))\n best_block_hash = rpc_connection.getbestblockhash()\n print(rpc_connection.getblock(best_block_hash))\n\n # batch support : print timestamps of blocks 0 to 99 in 2 RPC round-trips:\n commands = [ [ \"getblockhash\", height] for height in range(100) ]\n block_hashes = rpc_connection.batch_(commands)\n blocks = rpc_connection.batch_([ [ \"getblock\", h ] for h in block_hashes ])\n block_times = [ block[\"time\"] for block in blocks ]\n print(block_times)\n\nLogging all RPC calls to stderr\n===============================\n.. code:: python\n\n from bitcoinrpc.authproxy import AuthServiceProxy, JSONRPCException\n import logging\n\n logging.basicConfig()\n logging.getLogger(\"BitcoinRPC\").setLevel(logging.DEBUG)\n\n rpc_connection = AuthServiceProxy(\"http://%s:%s@127.0.0.1:8332\"%(rpc_user, rpc_password))\n print(rpc_connection.getinfo())\n\nProduces output on stderr like\n\n DEBUG:BitcoinRPC:-1-> getinfo []\n DEBUG:BitcoinRPC:<-1- {\"connections\": 8, ...etc }",
"bugtrack_url": null,
"license": "UNKNOWN",
"summary": "Enhanced version of python-jsonrpc for use with Bitcoin",
"version": "1.0",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "http://www.github.com/jgarzik/python-bitcoinrpc"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71eb80313654302a7f3ba2fa3a8ea9e4c65f910b353112df8da77e4974978665",
"md5": "f71d5de3212ad56475758ee56d29b79a",
"sha256": "a6a6f35672635163bc491c25fe29520bdd063dedbeda3b37bf5be97aa038c6e7"
},
"downloads": -1,
"filename": "python-bitcoinrpc-1.0.tar.gz",
"has_sig": false,
"md5_digest": "f71d5de3212ad56475758ee56d29b79a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13146,
"upload_time": "2016-08-24T05:14:20",
"upload_time_iso_8601": "2016-08-24T05:14:20.993627Z",
"url": "https://files.pythonhosted.org/packages/71/eb/80313654302a7f3ba2fa3a8ea9e4c65f910b353112df8da77e4974978665/python-bitcoinrpc-1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2016-08-24 05:14:20",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jgarzik",
"github_project": "python-bitcoinrpc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "python-bitcoinrpc"
}
JSON
