Bitmessage/PyBitmessage-2024-08-21
Archived
2
0
Fork 0
Code Issues 168 Pull Requests 53 Actions Packages Projects Releases 5 Wiki Activity

Fix docstrings in the api module

Browse Source
This commit is contained in:
Lee Miller 2022-11-16 04:12:34 +02:00
parent 2785e56fab
commit 5e2dcd70af
Signed by untrusted user: lee.miller
GPG Key ID: 4F97A5EA88F4AB63
1 changed files with 10 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/api.py
View File

@ -39,17 +39,18 @@ To use the API concider such simple example:
.. code-block:: python .. code-block:: python
import jsonrpclib from jsonrpclib import jsonrpc
from pybitmessage import bmconfigparser, helper_startup from pybitmessage import helper_startup
from pybitmessage.bmconfigparser import config
helper_startup.loadConfig() # find and load local config file helper_startup.loadConfig() # find and load local config file
conf = bmconfigparser.BMConfigParser() api_uri = "http://%s:%s@127.0.0.1:%s/" % (
api_uri = "http://%s:%s@127.0.0.1:8442/" % ( config.safeGet('bitmessagesettings', 'apiusername'),
conf.safeGet('bitmessagesettings', 'apiusername'), config.safeGet('bitmessagesettings', 'apipassword'),
conf.safeGet('bitmessagesettings', 'apipassword') config.safeGet('bitmessagesettings', 'apiport')
) )
api = jsonrpclib.ServerProxy(api_uri) api = jsonrpc.ServerProxy(api_uri)
print(api.clientStatus()) print(api.clientStatus())
@ -1445,8 +1446,8 @@ class BMRPCDispatcher(object):
@command('listConnections') @command('listConnections')
def HandleListConnections(self): def HandleListConnections(self):
""" """
Returns bitmessage connection information as dict with keys *inbound, Returns bitmessage connection information as dict with keys *inbound*,
*outbound. *outbound*.
""" """
inboundConnections = [] inboundConnections = []
outboundConnections = [] outboundConnections = []