search

lbryio / lbrycrd

The blockchain that provides the digital content namespace for the LBRY protocol
https://lbry.com
MIT License
2.57k stars 178 forks source link

Output blockchain APIs in a format that can be used for documentation #131

Closed kauffj closed 6 years ago

kauffj commented 6 years ago

lbry.tech will be used to showcase the API signatures for the daemon, blockchain, and any other key components.

kauffj commented 6 years ago

@lyoshenka did this get discussed on blockchain weekly?

BrannonKing commented 6 years ago

Waiting on #44

BrannonKing commented 6 years ago

Is this a duplicate of #143 ?

lyoshenka commented 6 years ago

yes. ill close the other one.

alyssaoc commented 6 years ago

reference #1276 from protocol

BrannonKing commented 6 years ago

Also, see https://github.com/lbryio/lbry.tech/issues/42 and https://github.com/lbryio/lbry/blob/master/scripts/generate_json_api.py

I'm starting on this now and planning to pursue the jrgen plan.

rynomad commented 6 years ago

@BrannonKing re: jrgen... if you'd like, take a look at this script I wrote for lbry-js; it's pretty barebones but generates a jrgen compatible schema file dynamically from the existing lbrycrd 'help' command.

BrannonKing commented 6 years ago

@rynomad , thanks for posting that script. Unfortunately, my Python script was generally completed before I got this message yesterday. Hence, I think I'll proceed with my script.

I was unable to run your script. I'm not sure I followed your instructions correctly. npm --version reports 3.5.2. Do I need some other version? (There was no setup command on mine.)

rynomad commented 6 years ago

Ah, my bad, I had local changes days ago I had forgotten to push, should be good to go; also i fixed the readme; it's supposed to say npm run setup