Package: privex-jsonrpc
Simple Python JsonRPCA small library for interacting with JsonRPC servicesIncludes some helper classes for various cryptocurrency daemons inc.bitcoindandlitecoindOfficial Repo:https://github.com/privex/python-jsonrpcQuick Install / Usagepip3installprivex-jsonrpcfromprivex.jsonrpcimportJsonRPC,RPCExceptiontry:j=JsonRPC(hostname='api.example.com',port=443,ssl=True)# call JsonRPC methods as if they're part of the class. they return 'result' as dict/list/int/float/strj.list_all('first','second')# 'params' as a list ['first', 'second']j.find(name='john')# 'params' as a dict {name: 'john'}exceptRPCExceptionase:# raised when the result contains the key 'error' and it is not null/falselog.exception('the rpc server returned an error:%s',str(e))except:# Any other exceptions (generally from the `requests` library) mean something is wrong with the serverlog.exception('something went wrong while communicating with the RPC server...')InformationThis Python JsonRPC library has been developed atPrivex Inc.by @someguy123 for interacting
with various JsonRPC services, including cryptocurrency daemons such asbitcoind.It uses thePython Requestslibrary, including a singleton requests session
ensuring that HTTP Keep-alive is always used, cookies are retained, among other things improving performance.The main classes included are:JsonRPC        - The main universally-compatible class, works with most JsonRPC services without any modification.

    BitcoinRPC     - Constructor connects to 127.0.0.1:8332 by default. 
                     Includes a few pre-defined methods for interacting with `bitcoind` and similar daemons.

    LitecoinRPC    - Same as BitcoinRPC, except uses 127.0.0.1:9332 by default

    SteemEngineRPC - For interacting with SteemSmartContracts RPC (https://github.com/harpagon210/steemsmartcontracts)
                     Includes pre-defined methods for interacting with SSC RPC. 
                     Default host: https://api.steem-engine.com

    MoneroRPC      - For interacting with Monero Wallet RPC, includes various pre-defined methods to make things easier.

    ElectrumRPC    - For interacting with Electrum Wallet RPC, includes various pre-defined methods to make things easier.
                     Should work with Bitcoin Electrum, Electrum LTC, and others.+===================================================+
|                 © 2019 Privex Inc.                |
|               https://www.privex.io               |
+===================================================+
|                                                   |
|        Python Simple JSON RPC library             |
|        License: X11/MIT                           |
|                                                   |
|        Core Developer(s):                         |
|                                                   |
|          (+)  Chris (@someguy123) [Privex]        |
|                                                   |
+===================================================+

Python JSON RPC - A simple library for interacting with JsonRPC services
Copyright (c) 2019    Privex Inc. ( https://www.privex.io )InstallWe recommend that you use at least Python 3.4+ due to the usage of parameter and return type hinting.Install from PyPi usingpipYou can install this package via pip:pip3installprivex-jsonrpc(Alternative) Manual install from GitIf you don't want to PyPi (e.g. for development versions not on PyPi yet), you can install the
project directly from our Git repo.Unless you have a specific reason to manually install it, youshould install it using pip3 normallyas shown above.Option 1 - Use pip to install straight from Githubpip3installgit+https://github.com/Privex/python-jsonrpcOption 2 - Clone and install manually# Clone the repository from Githubgitclonehttps://github.com/Privex/python-jsonrpccdpython-jsonrpc# RECOMMENDED MANUAL INSTALL METHOD# Use pip to install the source codepip3install.# ALTERNATIVE INSTALL METHOD# If you don't have pip, or have issues with installing using it, then you can use setuptools instead.python3setup.pyinstallUsageImport the class that you need fromprivex.jsonrpc- all are exported using theinit.pyBasic usage:fromprivex.jsonrpcimportJsonRPC,RPCExceptiontry:j=JsonRPC(hostname='api.example.com',port=443,ssl=True)# Sends a POST request to https://api.example.com with the following data:# {id: 1, jsonrpc: '2.0', method: 'list_all', params: ['my first parameter']}data=j.list_all('my first parameter')# returns: ['some', 'result', 'data', 'returned']print(data[0])# prints 'some'# Sends a POST request to https://api.example.com with the following data:# {id: 2, jsonrpc: '2.0', method: 'find', params: {name: 'john'}}data=j.find(name='john')# returns: {name: 'john', username: 'john123', created_at: '2019-01-01 00:00:00'}print(data['username'])# prints 'john123'# If your JsonRPC call is not valid as a method name, use .call(method, *params, **args)# positional params are converted to a list, keyworg args are converted to a dictj.call('invalid-python.methodname','1st param','2nd param')j.call('some.find.func',name='john',user='john123')exceptRPCExceptionase:# RPCException is raised when the result contains the key 'error' and it is not null/falselog.exception('the rpc server returned an error:%s',str(e))except:# Any other exceptions (generally from the `requests` library) mean something is wrong with the serverlog.exception('something went wrong while communicating with the RPC server...')If a method is not defined, you can still use it! You just won't get any IDE hints with the parameters.For full parameter documentation, IDEs such as PyCharm and even Visual Studio Code should show our PyDoc
comments when you try to use the class.For PyCharm, press F1 with your keyboard cursor over the class to see full function documentation, including
return types, parameters, and general usage information. You can also press CMD-P with your cursor inside of
a method's brackets (including the constructor brackets) to see the parameters you can use.Alternatively, just view the files inside ofprivex/jsonrpc/- most methods and constructors
are adequently commented with PyDoc.LoggingBy default, this package will log anything >=WARNING to the console. You can override this by adjusting theprivex.jsonrpclogger instance.We recommend checking out our Python packagePython Loghelperwhich
makes it easy to manage your logging configuration, and copy it to other logging instances such as this one.# Without LogHelperimportloggingl=logging.getLogger('privex.jsonrpc')l.setLevel(logging.ERROR)# With LogHelper (pip3 install privex-loghelper)fromprivex.loghelperimportLogHelper# Set up logging for **your entire app**. In this case, log only messages >=errorlh=LogHelper('myapp',handler_level=logging.ERROR)lh.add_file_handler('test.log')# Log messages to the file `test.log` in the current directorylh.copy_logger('privex.jsonrpc')# Easily copy your logging settings to any other module loggerslog=lh.get_logger()# Grab your app's logging instance, or use logging.getLogger('myapp')log.error('Hello World')ContributingWe're very happy to accept pull requests, and work on any issues reported to us.Here's some important information:Reporting Issues:For bug reports, you should include the following information:Version ofprivex-jsonrpcandrequeststested on - usepip3 freezeIf not installed via a PyPi release, git revision number that the issue was tested on -git log -n1Your python3 version -python3 -VYour operating system and OS version (e.g. Ubuntu 18.04, Debian 7)For feature requests / changesPlease avoid suggestions that require new dependencies. This tool is designed to be lightweight, not filled with
external dependencies.Clearly explain the feature/change that you would like to be addedExplain why the feature/change would be useful to us, or other users of the toolBe aware that features/changes that are complicated to add, or we simply find un-necessary for our use of the tool may not be added (but we may accept PRs)Pull Requests:We'll happily accept PRs that only add code comments or README changesUse 4 spaces, not tabs when contributing to the codeYou can use features from Python 3.4+ (we run Python 3.7+ for our projects)Features that require a Python version that has not yet been released for the latest stable release
of Ubuntu Server LTS (at this time, Ubuntu 18.04 Bionic) will not be accepted.Clearly explain the purpose of your pull request in the title and descriptionWhat changes have you made?Why have you made these changes?Please make sure that code contributions are appropriately commented - we won't accept changes that involve uncommented, highly terse one-liners.Legal Disclaimer for ContributionsNobody wants to read a long document filled with legal text, so we've summed up the important parts here.If you contribute content that you've created/own to projects that are created/owned by Privex, such as code or documentation, then you might automatically grant us unrestricted usage of your content, regardless of the open source license that applies to our project.If you don't want to grant us unlimited usage of your content, you should make sure to place your content
in a separate file, making sure that the license of your content is clearly displayed at the start of the file (e.g. code comments), or inside of it's containing folder (e.g. a file named LICENSE).You should let us know in your pull request or issue that you've included files which are licensed
separately, so that we can make sure there's no license conflicts that might stop us being able
to accept your contribution.If you'd rather read the whole legal text, it should be included asprivex_contribution_agreement.txt.LicenseThis project is licensed under theX11 / MITlicense. See the fileLICENSEfor full details.Here's the important bits:You must include/display the license & copyright notice (LICENSE) if you modify/distribute/copy
some or all of this project.You can't use our name to promote / endorse your product without asking us for permission.
You can however, state that your product uses some/all of this project.Thanks for reading!If this project has helped you, considergrabbing a VPS or Dedicated Server from Privex- prices start at as little as US$8/mo (we take cryptocurrency!)