LBRYCommunity/lbry-sdk
1
0
Fork 1
Code Issues Pull requests Projects Releases 282 Packages Wiki Activity

update docs

Browse source
This commit is contained in:
Alex Grintsvayg 2017-02-28 12:31:55 -05:00
parent e8afad7af8
commit 0e76ca0767
2 changed files with 96 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

146
docs/index.md
View file

@ -1,16 +1,5 @@
# LBRY JSON-RPC API Documentation # LBRY JSON-RPC API Documentation
## abandon_name
```text
DEPRECIATED, use abandon_claim
Args:
'txid': txid of claim, string
Return:
txid
```
## blob_announce_all ## blob_announce_all
```text ```text
@ -21,24 +10,49 @@ Args:
Returns: Returns:
``` ```
## blob_delete
```text
Delete a blob
Args:
blob_hash
Returns:
Success/fail message
```
## blob_get ## blob_get
```text ```text
Download and return a sd blob Download and return a blob
Args: Args:
sd_hash blob_hash
timeout (optional)
encoding (optional): by default no attempt at decoding is made
can be set to one of the following decoders:
json
payment_rate_manager (optional): if not given the default payment rate manager
will be used. supported alternative rate managers:
only-free
Returns Returns
sd blob, dict Success/Fail message or decoded data
``` ```
## blob_list ## blob_list
```text ```text
Returns all blob hashes Returns blob hashes, if not given filters returns all blobs known by the blob manager
Args: Args:
None uri (str, optional): filter by blobs in stream for winning claim
stream_hash (str, optional): filter by blobs in given stream hash
sd_hash (str, optional): filter by blobs in given sd hash
needed (bool, optional): only return needed blobs
finished (bool, optional): only return finished blobs
page_size (int, optional): limit number of results returned
page (int, optional): filter to page x of [page_size] results
Returns: Returns:
list of blob hashes list of blob hashes
``` ```
@ -139,16 +153,6 @@ Returns:
list list
``` ```
## configure_ui
```text
Configure the UI being hosted
Args, optional:
'branch': a branch name on lbryio/lbry-web-ui
'path': path to a ui folder
```
## daemon_stop ## daemon_stop
```text ```text
@ -158,6 +162,22 @@ Returns:
shutdown message shutdown message
``` ```
## descriptor_get
```text
Download and return a sd blob
Args:
sd_hash
timeout (optional)
payment_rate_manager (optional): if not given the default payment rate manager
will be used. supported alternative rate managers:
only-free
Returns
Success/Fail message or decoded data
```
## file_delete ## file_delete
```text ```text
@ -172,23 +192,35 @@ Returns:
## file_get ## file_get
```text ```text
Get a file Get a file, if no matching file exists returns False
Args: Args:
'name': get file by lbry uri, 'name': get file by lbry uri,
'sd_hash': get file by the hash in the name claim, 'sd_hash': get file by the hash in the name claim,
'file_name': get file by its name in the downloads folder, 'file_name': get file by its name in the downloads folder,
'stream_hash': get file by its stream hash
Returns: Returns:
'completed': bool 'completed': bool,
'file_name': string 'file_name': str,
'key': hex string 'download_directory': str,
'points_paid': float 'points_paid': float,
'stopped': bool 'stopped': bool,
'stream_hash': base 58 string 'stream_hash': str (hex),
'stream_name': string 'stream_name': str,
'suggested_file_name': string 'suggested_file_name': str,
'upload_allowed': bool 'sd_hash': str (hex),
'sd_hash': string 'lbry_uri': str,
'txid': str (b58),
'claim_id': str (b58),
'download_path': str,
'mime_type': str,
'key': str (hex),
'total_bytes': int,
'written_bytes': int,
'code': str,
'message': str
'metadata': Metadata dict if claim is valid, otherwise status str
}
``` ```
## file_list ## file_list
@ -208,7 +240,6 @@ Returns:
'stream_hash': base 58 string 'stream_hash': base 58 string
'stream_name': string 'stream_name': string
'suggested_file_name': string 'suggested_file_name': string
'upload_allowed': bool
'sd_hash': string 'sd_hash': string
``` ```
@ -233,10 +264,10 @@ Download stream from a LBRY uri.
Args: Args:
'name': name to download, string 'name': name to download, string
'download_directory': optional, path to directory where file will be saved, string
'file_name': optional, a user specified name for the downloaded file 'file_name': optional, a user specified name for the downloaded file
'stream_info': optional, specified stream info overrides name 'stream_info': optional, specified stream info overrides name
'timeout': optional 'timeout': optional
'download_directory': optional, path to directory where file will be saved, string
'wait_for_write': optional, defaults to True. When set, waits for the file to 'wait_for_write': optional, defaults to True. When set, waits for the file to
only start to be written before returning any results. only start to be written before returning any results.
Returns: Returns:
@ -251,6 +282,8 @@ Get stream availability for a winning claim
Arg: Arg:
name (str): lbry uri name (str): lbry uri
sd_timeout (int, optional): sd blob download timeout
peer_timeout (int, optional): how long to look for peers
Returns: Returns:
peers per blob / total blobs peers per blob / total blobs
@ -290,6 +323,17 @@ Returns:
otherwise returns general help message otherwise returns general help message
``` ```
## open
```text
Instruct the OS to open a file with its default program.
Args:
'sd_hash': SD hash of file to be opened
Returns:
True, opens file
```
## peer_list ## peer_list
```text ```text
@ -297,6 +341,7 @@ Get peers for blob hash
Args: Args:
'blob_hash': blob hash 'blob_hash': blob hash
'timeout' (int, optional): peer search timeout
Returns: Returns:
List of contacts List of contacts
``` ```
@ -307,18 +352,19 @@ Returns:
Make a new name claim and publish associated data to lbrynet Make a new name claim and publish associated data to lbrynet
Args: Args:
'name': name to be claimed, string 'name': str, name to be claimed, string
'file_path': path to file to be associated with name, string 'bid': float, amount of credits to commit in this claim,
'bid': amount of credits to commit in this claim, float 'metadata': dict, Metadata compliant (can be missing sources if a file is provided)
'metadata': metadata dictionary 'file_path' (optional): str, path to file to be associated with name, if not given
optional 'fee' the stream from your existing claim for the name will be used
'fee' (optional): dict, FeeValidator compliant
Returns: Returns:
'success' : True if claim was succesful , False otherwise 'success' : True if claim was succesful , False otherwise
'reason' : if not succesful, give reason 'reason' : if not succesful, give reason
'txid' : txid of resulting transaction if succesful 'txid' : txid of resulting transaction if succesful
'nout' : nout of the resulting support claim if succesful 'nout' : nout of the resulting support claim if succesful
'fee' : fee paid for the claim transaction if succesful 'fee' : fee paid for the claim transaction if succesful
'claimid' : claimid of the resulting transaction 'claim_id' : claim id of the resulting transaction
``` ```
## reflect ## reflect
@ -351,7 +397,7 @@ Resolve stream info from a LBRY uri
Args: Args:
'name': name to look up, string, do not include lbry:// prefix 'name': name to look up, string, do not include lbry:// prefix
Returns: Returns:
metadata from name claim metadata from name claim or None if the name is not known
``` ```
## reveal ## reveal
@ -360,7 +406,7 @@ Returns:
Reveal a file or directory in file browser Reveal a file or directory in file browser
Args: Args:
'path': path to be selected in file browser 'path': path to be revealed in file browser
Returns: Returns:
True, opens file browser True, opens file browser
``` ```
@ -380,10 +426,8 @@ Returns:
## settings_get ## settings_get
```text ```text
Get lbrynet daemon settings Get daemon settings
Args:
None
Returns: Returns:
'run_on_startup': bool, 'run_on_startup': bool,
'data_rate': float, 'data_rate': float,
@ -405,7 +449,7 @@ Returns:
## settings_set ## settings_set
```text ```text
Set lbrynet daemon settings Set daemon settings
Args: Args:
'run_on_startup': bool, 'run_on_startup': bool,

2
scripts/gen_api_docs.py
View file

@ -84,7 +84,7 @@ def _link(name, anchor=None):
def main(): def main():
curdir = op.dirname(op.realpath(__file__)) curdir = op.dirname(op.realpath(__file__))
path = op.realpath(op.join(curdir, '..', 'docs', 'api.md')) path = op.realpath(op.join(curdir, '..', 'docs', 'index.md'))
klass = Daemon klass = Daemon