| t |
","
"]),v.fn.extend({text:function(e){return v.access(this,function(e){return e===t?v.text(this):this.empty().append((this[0]&&this[0].ownerDocument||i).createTextNode(e))},null,e,arguments.length)},wrapAll:function(e){if(v.isFunction(e))return this.each(function(t){v(this).wrapAll(e.call(this,t))});if(this[0]){var t=v(e,this[0].ownerDocument).eq(0).clone(!0);this[0].parentNode&&t.insertBefore(this[0]),t.map(function(){var e=this;while(e.firstChild&&e.firstChild.nodeType===1)e=e.firstChild;return e}).append(this)}return this},wrapInner:function(e){return v.isFunction(e)?this.each(function(t){v(this).wrapInner(e.call(this,t))}):this.each(function(){var t=v(this),n=t.contents();n.length?n.wrapAll(e):t.append(e)})},wrap:function(e){var t=v.isFunction(e);return this.each(function(n){v(this).wrapAll(t?e.call(this,n):e)})},unwrap:function(){return this.parent().each(function(){v.nodeName(this,"body")||v(this).replaceWith(this.childNodes)}).end()},append:function(){return this.domManip(arguments,!0,function(e){(this.nodeType===1||this.nodeType===11)&&this.appendChild(e)})},prepend:function(){return this.domManip(arguments,!0,function(e){(this.nodeType===1||this.nodeType===11)&&this.insertBefore(e,this.firstChild)})},before:function(){if(!ut(this[0]))return this.domManip(arguments,!1,function(e){this.parentNode.insertBefore(e,this)});if(arguments.length){var e=v.clean(arguments);return this.pushStack(v.merge(e,this),"before",this.selector)}},after:function(){if(!ut(this[0]))return this.domManip(arguments,!1,function(e){this.parentNode.insertBefore(e,this.nextSibling)});if(arguments.length){var e=v.clean(arguments);return this.pushStack(v.merge(this,e),"after",this.selector)}},remove:function(e,t){var n,r=0;for(;(n=this[r])!=null;r++)if(!e||v.filter(e,[n]).length)!t&&n.nodeType===1&&(v.cleanData(n.getElementsByTagName("*")),v.cleanData([n])),n.parentNode&&n.parentNode.removeChild(n);return this},empty:function(){var e,t=0;for(;(e=this[t])!=null;t++){e.nodeType===1&&v.cleanData(e.getElementsByTagName("*"));while(e.firstChild)e.removeChild(e.firstChild)}return this},clone:function(e,t){return e=e==null?!1:e,t=t==null?e:t,this.map(function(){return v.clone(this,e,t)})},html:function(e){return v.access(this,function(e){var n=this[0]||{},r=0,i=this.length;if(e===t)return n.nodeType===1?n.innerHTML.replace(ht,""):t;if(typeof e=="string"&&!yt.test(e)&&(v.support.htmlSerialize||!wt.test(e))&&(v.support.leadingWhitespace||!pt.test(e))&&!Nt[(vt.exec(e)||["",""])[1].toLowerCase()]){e=e.replace(dt,"<$1>");try{for(;r
|
+ + |
B
+| + |
C
+
|
+ + |
D
+
|
+
|
+
G
+I
+
|
+ + |
J
+
|
+
K
+
|
+ + |
L
+| + | + |
M
+
|
+ + |
N
+
|
+
O
+
|
+
R
+| + | + |
S
+T
+
|
+
|
+
V
+| + | + |
W
+| + |
|
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/index.html b/doc/index.html
new file mode 100644
index 0000000..7891851
--- /dev/null
+++ b/doc/index.html
@@ -0,0 +1,143 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Getting Started¶
+ +
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/introduction.html b/doc/introduction.html
new file mode 100644
index 0000000..d2bbcbf
--- /dev/null
+++ b/doc/introduction.html
@@ -0,0 +1,155 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ verge-python - Easy-to-use VERGE API client.¶
+verge-python is a set of Python libraries that allows easy access to the +verge peer-to-peer cryptocurrency client API.
+Contents:
+
+
+-
+
- Getting Started
-
+
- Introduction +
- Usage +
- Examples +
+ - API reference + +
+
+Indices and tables¶
+-
+
- Index +
- Module Index +
- Search Page +
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/objects.inv b/doc/objects.inv
new file mode 100644
index 0000000..7ed03ad
Binary files /dev/null and b/doc/objects.inv differ
diff --git a/doc/py-modindex.html b/doc/py-modindex.html
new file mode 100644
index 0000000..0025ea8
--- /dev/null
+++ b/doc/py-modindex.html
@@ -0,0 +1,134 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Introduction¶
+The goal of this library is to make it easier for:
+-
+
- Payment gateways to support verge +
- Merchant sites to integrate verge payments directly +
- Other services that require (micro-)payments to use verge +
In this initial release it implements a thin wrapper around the +VERGE JSON-RPC API. Using this API from Python directly is conceptually very simple, +here is the example from the API +documentation page:
+from jsonrpc import ServiceProxy
+
+access = ServiceProxy("http://user:password@127.0.0.1:8332")
+access.getinfo()
+access.listreceivedbyaddress(6)
+access.sendtoaddress("11yEmxiMso2RsFVfBcCa616npBvGgxiBX", 10)
+However, this approach has some disadvantages, one thing is that error handling is complex, as it +requires manually checking the contents of JSONException objects.
+verge-python attempts to create an even more friendly interface by wrapping the JSON-RPC API. The major advantages +compared to a raw jsonrpc based approach are:
+-
+
- Better exception handling. Exceptions are converted to subclasses of VERGEException. +
- Automatic verge configuration loading. In case the verge -server or verged program runs on the same +machine as the client script, and as the same user, the configuration file can automatically be parsed. This +makes it unneccesary to explicitly specify a username and password. Of course, this is still possible. +
- Documentation in Pythonish format. You are reading this right now. +
- The functions +getinfo(), listreceivedbyaccount(), +listreceivedbyaddress(), +listtransactions() and more return actual Python objects, instead of simply +dictionaries. This makes for cleaner code, as the fields can simply be addressed with x.foo instead of +x['foo']. +
The plan for future releases is to add a more high-level interface on top of this.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/search.html b/doc/search.html
new file mode 100644
index 0000000..061804e
--- /dev/null
+++ b/doc/search.html
@@ -0,0 +1,105 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Python Module Index
+ +
+ d
+
+
+ | + d | ||
| + | + vergerpc | + |
| + | + vergerpc.config | + |
| + | + vergerpc.connection | + |
| + | + vergerpc.data | + |
| + | + vergerpc.exceptions | + |
| + | + vergerpc.util | + |
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/searchindex.js b/doc/searchindex.js
new file mode 100644
index 0000000..76694eb
--- /dev/null
+++ b/doc/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({titles:["vergerpc.util — Generic utilities used by verge client library","vergerpc — Convenience functions","Examples","vergerpc.exceptions — Exception definitions","API reference","Introduction","vergerpc.data — VERGE RPC service, data objects","vergerpc.config — Utilities for reading verge configuration files","Getting Started","vergerpc.connection — Connect to VERGE server via JSON-RPC","Usage","verge-python - Easy-to-use VERGE API client."],objnames:{"0":["py","module","Python module"],"1":["py","exception","Python exception"],"2":["py","method","Python method"],"3":["py","class","Python class"],"4":["py","function","Python function"],"5":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:exception","2":"py:method","3":"py:class","4":"py:function","5":"py:attribute"},objects:{"":{vergerpc:[1,0,0,"-"]},"vergerpc.util":{DStruct:[0,3,1,""]},"vergerpc.connection":{VERGEConnection:[9,3,1,""]},vergerpc:{data:[6,0,0,"-"],config:[7,0,0,"-"],util:[0,0,0,"-"],connect_to_local:[1,4,1,""],exceptions:[3,0,0,"-"],connect_to_remote:[1,4,1,""],connection:[9,0,0,"-"]},"vergerpc.exceptions":{wrap_exception:[3,4,1,""],WalletError:[3,1,1,""],NotConnected:[3,1,1,""],SafeMode:[3,1,1,""],VERGEException:[3,1,1,""],DownloadingBlocks:[3,1,1,""],InvalidParameter:[3,1,1,""],WalletPassphraseIncorrect:[3,1,1,""],InvalidTransactionID:[3,5,1,""],WalletEncryptionFailed:[3,1,1,""],SendError:[3,5,1,""],WalletWrongEncState:[3,1,1,""],ClientException:[3,1,1,""],OutOfMemory:[3,1,1,""],TransportException:[3,1,1,""],WalletUnlockNeeded:[3,1,1,""],KeypoolRanOut:[3,1,1,""],WalletAlreadyUnlocked:[3,1,1,""],JSONTypeError:[3,1,1,""],InvalidAddressOrKey:[3,1,1,""],InsufficientFunds:[3,1,1,""],InvalidAmount:[3,5,1,""],InvalidAccountName:[3,1,1,""]},"vergerpc.data":{MiningInfo:[6,3,1,""],AccountInfo:[6,3,1,""],TransactionInfo:[6,3,1,""],WorkItem:[6,3,1,""],ServerInfo:[6,3,1,""],AddressInfo:[6,3,1,""],AddressValidation:[6,3,1,""]},"vergerpc.connection.VERGEConnection":{getaccountaddress:[9,2,1,""],listunspent:[9,2,1,""],getmininginfo:[9,2,1,""],getinfo:[9,2,1,""],getblock:[9,2,1,""],validateaddress:[9,2,1,""],getbalance:[9,2,1,""],listreceivedbyaccount:[9,2,1,""],sendfrom:[9,2,1,""],sendtoaddress:[9,2,1,""],stop:[9,2,1,""],backupwallet:[9,2,1,""],listtransactions:[9,2,1,""],keypoolrefill:[9,2,1,""],walletlock:[9,2,1,""],setaccount:[9,2,1,""],getrawtransaction:[9,2,1,""],getreceivedbyaccount:[9,2,1,""],decoderawtransaction:[9,2,1,""],getreceivedbyaddress:[9,2,1,""],move:[9,2,1,""],getgenerate:[9,2,1,""],setgenerate:[9,2,1,""],getconnectioncount:[9,2,1,""],signmessage:[9,2,1,""],gettransaction:[9,2,1,""],getblockcount:[9,2,1,""],getblocknumber:[9,2,1,""],verifymessage:[9,2,1,""],walletpassphrasechange:[9,2,1,""],getdifficulty:[9,2,1,""],getaddressesbyaccount:[9,2,1,""],walletpassphrase:[9,2,1,""],sendmany:[9,2,1,""],listaccounts:[9,2,1,""],dumpprivkey:[9,2,1,""],getaccount:[9,2,1,""],gettxout:[9,2,1,""],listreceivedbyaddress:[9,2,1,""],getwork:[9,2,1,""],getblockhash:[9,2,1,""],getnewaddress:[9,2,1,""],importprivkey:[9,2,1,""],gethashespersec:[9,2,1,""],createrawtransaction:[9,2,1,""],signrawtransaction:[9,2,1,""]},"vergerpc.config":{read_config_file:[7,4,1,""],read_default_config:[7,4,1,""]}},envversion:43,filenames:["vergerpc.util","vergerpc","examples","vergerpc.exceptions","apireference","introduction","vergerpc.data","vergerpc.config","gettingstarted","vergerpc.connection","usage","index"],terms:{currentblocktx:6,also:10,paytxfe:6,doe:2,credit:9,ran:3,etc:3,block:[3,9,2,6],spend:9,usag:[],even:5,clientexcept:3,raw:[9,5],again:[9,10],all:9,between:10,main:10,specifi:[9,5,10],get:[],time:9,proxi:6,getbal:[9,10],origin:2,argument:[9,1,7,10],about:[9,10],give:10,node:9,level:[3,5],isvalid:[6,10],signatur:9,dat:9,move:[9,2,6],access:[11,5],skip:9,args_t:[0,6],com:10,getconnectioncount:9,passphras:[3,9],invalidaccountnam:3,ismin:6,implement:5,enabl:[9,6],args_d:[0,6],last:9,associ:[9,6],pars:[5,7],tri:9,deni:3,program:[5,2],importprivkei:9,found:3,effici:0,output:9,insufficientfund:[3,2],load:5,friendli:5,handl:5,getgener:9,yoyodyn:10,timestamp:6,command:[3,10],same:5,unneccesari:5,either:[9,10],variou:9,"function":[],getinfo:[9,5,2,10,6],disadvantag:5,dont_rais:9,"class":[0,9,6,3],"case":[5,2],consid:9,abl:[9,10],insuffici:3,invalidtransactionid:3,server:[],util:[],sourc:9,connect_to_loc:[1,2,10],hashespersec:6,more:[0,5,10,3],createrawtransact:9,unspent:9,maxconf:9,account:[],wrap:5,pass:3,invalidparamet:3,p2p:3,raw_detail:3,error:[3,5,6,7],serial:9,verbos:9,thin:[9,5],getdifficulti:9,onc:10,readabl:9,retriev:2,actual:5,private_kei:9,out:[3,10],input:9,onli:[9,6],vergeconnect:[9,1,2],peer:[3,11],bar:10,broke:2,gettransact:9,four:10,easi:[],requir:[9,5],thank:10,call:[3,9,2],pay_to:10,given:[3,9],conceptu:5,automat:5,outofmemori:3,unlock:[3,9],incorrect:3,look:2,"true":[9,6],than:9,count:9,minconf:9,thi:[1,2,3,5,9,10],acct:9,defin:[3,9],unless:9,listunsp:9,proof:9,introduct:[],conf:10,altcoin:9,copi:9,queri:9,produc:9,conn:[9,2,10],oper:3,localhost:[9,1],validateaddress:[9,6,10],accountinfo:[9,6],must:10,you:[9,5,10],done:10,walletpassphras:[3,9],goal:5,first:[3,9,2,6],processor:[9,6],simpli:[5,10],fee:6,"default":[9,1,7,10],vergeaddress:9,code:[3,5],otheraccount:6,chain:9,transact:[3,9,6],password:[5,9,1,10],unicod:9,pleas:10,setaccount:9,credenti:10,add:[9,5],multipl:[9,10],specif:3,fund:[3,2,6],latest:9,dynam:0,script:5,verged:[3,5,10],enter:3,unexpect:3,never:3,support:5,own:1,make:5,unabl:7,transport:3,version:6,memori:[0,9,3],name:[3,9,6],after:[9,6,10],host:[9,1,10],certain:[9,10],most:[6,10],getreceivedbyaccount:9,testnet:6,transcat:9,gettxout:9,cryptocurr:11,disablesafemod:3,page:[11,5],befor:9,mode:3,separ:10,walletpassphraseincorrect:[3,9],gethashespersec:9,attempt:5,much:10,confirm:[9,6],list:9,directori:[9,7,10],ioerror:7,altern:1,easiest:10,subclass:5,should:9,walletalreadyunlock:3,occur:7,buffer:6,work:9,here:5,manual:5,fill:9,pythonish:5,thei:9,cleaner:5,from_:9,togeth:10,dstruct:[0,6],haven:9,machin:[5,1,2,10],minimum:9,site:5,previou:[9,10],jsonrpc:5,receiv:[3,9,6,10],human:9,getblocknumb:9,fail:[3,9],decod:9,high:5,filenam:[9,1,7],your:[9,10],compar:5,connect:[],"while":9,been:10,advanc:10,map:9,how:[],read_config_fil:7,approach:5,includeempti:9,simpl:[0,5,7],keep:9,redeemscript:9,serviceproxi:5,paramet:[3,9,10],base58:9,right:5,deprec:9,coin:[9,10],problem:3,midstat:6,per:[9,6],whether:[9,10],failur:3,mempool:9,transactioninfo:[9,6],standard:[1,7],from:[],sent:6,fromaccount:9,modul:11,blockchain:9,validat:6,open:7,two:10,success:9,precomput:6,solv:9,send:[9,6,10],"new":[9,10],convert:[3,5],getaccountaddress:9,getmininginfo:[9,6],allow:[9,10,11],integr:5,privat:9,signmessag:9,softwar:10,set:[],current:[7,9,2,10,6],remov:9,basic:[2,10],remot:[],perform:9,merchant:5,recommend:9,previous_transact:9,see:10,via:[],hostnam:10,limit:6,serverinfo:[9,6],valueerror:7,best:9,use_http:[9,1],which:[9,6],walletencryptionfail:3,mkzbybiq6dnoqekakpmjegydbw2yinqnht:9,locat:[1,7],senderror:3,signrawtransact:9,transportexcept:3,repres:9,listaccount:9,setgener:9,local:[1,2,10],gener:[],configur:[],rpc:[],oldest:6,categori:6,whose:9,walleterror:3,chang:9,pirat:10,search:11,possibl:[9,5],littl:6,transactiond:9,second:[9,6],sign:9,prepar:10,destin:9,timeout:9,recent:[9,6],form:9,longest:9,workitem:[9,6],vout:9,futur:5,"11yemximso2rsfvfbcca616npbvggxibx":5,number:[9,6],encod:9,sendmani:9,made:10,except:[],tovergeaddress:9,jsontypeerror:3,epoch:6,keypoolrefil:[3,9],explicitli:[5,10],getnewaddress:[9,10],were:6,safemod:3,as_dict:9,less:[0,9],begin:10,a9d4599e15b53f3eb531608ddb31f48c695c3d0b3538a6bda871e8b34f2f430c:9,todict:9,dure:3,maxim:9,comment_to:9,none:[3,9,1,7],notconnect:3,object:[],clear:10,yet:9,accept:10,network:[3,6],instanc:[1,2,10],place:10,collect:0,rpcuser:10,sendfrom:9,mstgam1apjejfswfaarvazhrm26mv5gl73:10,least:9,each:9,howev:[5,10],verge:[],mine:9,depend:9,"try":2,alia:3,off:9,txid:[9,6],"float":9,submit:9,anoth:9,vergeexcept:[3,5],downloadingblock:3,target:6,ship:10,automag:10,listreceivedbyaddress:[9,5,6],read:[],detail:[9,10],config:[],easier:5,encrypt:[3,9,6],custom:10,authent:9,amount:[9,6,10],addressvalid:[9,6],verifymessag:9,backup:9,getreceivedbyaddress:[9,10],control:[],sinc:6,home:[7,10],background:10,path:[9,1,7],verifi:9,fals:[9,1,6],endian:6,hash1:6,print:[2,10],still:[3,5],utxo:9,hexstr:9,have:[2,10],file:[],download:3,unspecifi:3,behav:9,wrong:3,alreadi:3,unlimit:9,oldpassphras:9,pai:6,structur:0,els:10,dictionari:[9,5],type:[3,9],walletwrongencst:3,definit:[],document:[5,10],complex:5,getaddressesbyaccount:9,initi:5,statist:2,balanc:[9,6,10],instead:[9,5],real:6,plan:5,want:10,turn:9,complet:[3,9],python:[],round:9,decrypt:9,rais:[3,9,7],interfac:5,anyth:10,log:[9,10],unlocked_until:6,belong:9,some:[5,2],wallet:[],"catch":2,book:9,walletlock:9,json:[],comment:9,bool:9,releas:5,cours:5,non:[1,7],conveni:[],run:[3,5,2,10],half:6,vergerpc:[],sandwidth:10,like:[0,9,2],payment:[9,5,10],keypool:[3,9,6],check:[5,10],state:[3,9,6],total:[9,6],newpassphras:9,wrap_except:3,string:9,msg:3,exampl:[],foo:[5,10],stop:9,size:6,sort:10,invalidaddressorkei:3,mai:9,usernam:5,format:[9,5,6],wai:10,testaccount2:2,messag:[9,6],field:5,invalid:[3,10],addressinfo:[9,6],neccesari:10,mani:10,data:[],measur:9,getwork:[9,6],gatewai:5,content:[11,5],pool:[9,6],user:[1,2,5,7,9,10],connect_to_remot:[1,10],base:[0,9,5,6,3],contain:9,top:5,"public":9,mininginfo:[9,6],safe:[3,9,10],superclass:3,protocol:3,keypoolranout:3,delimit:7,getblock:9,getaccount:9,walletpassphrasechang:9,rescan:9,hash:[9,6],listreceivedbyaccount:[9,5,6],decoderawtransact:9,better:5,"import":[9,5,2,10],currentblocks:6,str:9,inform:[9,2,10,6],getrawtransact:9,within:10,method:[9,10],correct:10,difficulti:[9,2,6],provid:[3,9,10],backupwallet:9,jsonexcept:5,info:[9,2],port:[9,1,10],listtransact:[9,5,6],pooledtx:6,empti:9,sendtoaddress:[9,5,10],advantag:5,rpcpassword:10,servic:[],ani:[3,9,6,10],address:[3,9,5,6,10],avail:[9,2],thing:5,creat:[9,5,10],valid:[9,10],scriptpubkei:9,major:5,includ:[9,6],write:10,walletunlockneed:3,dogeconf:10,keypoololdest:6,genproclimit:[9,6],disabl:9,option:[9,1,7],builtin:[0,9,3],lock:[9,6],index:[9,11],nearest:9,wrapper:[9,5],getblockcount:9,veri:5,valu:9,transfer:9,http:[5,10],privkei:9,store:[9,10],directli:5,can:[9,5,10],when:10,invalidamount:3,paid:[9,6],around:[9,5],now:5,constructor:9,need:9,flexibl:0,kei:[3,9,6],process:10,testaccount:2,hex:9,read_default_config:7,"return":[1,2,5,6,9,10],micro:5,bank:10,getblockhash:9,dumpprivkei:9,toaccount:9,other:[3,9,5,6],enough:2,client:[],result:9,namedtupl:0},titleterms:{config:7,conveni:1,how:10,"function":1,introduct:5,object:6,set:10,easi:11,refer:4,remot:10,server:9,util:[0,7],control:10,exampl:2,usag:10,vergerpc:[0,1,3,7,6,9],python:[11,10],via:9,connect:[9,10],account:10,wallet:10,definit:3,indic:11,file:7,tabl:11,read:7,from:10,except:3,servic:6,data:6,librari:0,verge:[0,6,7,9,10,11],gener:0,json:9,get:8,configur:7,rpc:[9,6],api:[4,10,11],start:8,client:[0,11]}})
\ No newline at end of file
diff --git a/doc/usage.html b/doc/usage.html
new file mode 100644
index 0000000..88f729a
--- /dev/null
+++ b/doc/usage.html
@@ -0,0 +1,226 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Search
+
+
+
+ + Please activate JavaScript to enable the search + functionality. +
++ From here you can search these documents. Enter your search + words into the box below and click "search". Note that the search + function will automatically search for all of the words. Pages + containing fewer words won't appear in the result list. +
+ + +
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/vergerpc.config.html b/doc/vergerpc.config.html
new file mode 100644
index 0000000..449c256
--- /dev/null
+++ b/doc/vergerpc.config.html
@@ -0,0 +1,128 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Usage¶
+See also the `main verge documentation`_ for details and background on setting up and +using verged remotely.
+
+
+
+
+
+
+Setting up verge for remote control¶
+If you run VERGE with the -server argument, or if you run verged, it can be controlled +either by sending it HTTP-JSON-RPC commands.
+However, beginning with VERGE 0.3.3 you must create a verge.conf file in the VERGE data directory +(default $HOME/.dogeconf) and set an RPC password:
+rpcuser=anything
+rpcpassword=anything
+Once that is done, the easiest way to check whether VERGE accepts remote commands is by running +VERGE again, with the command (and any parameters) as arguments. For example:
+$ verged getinfo
+
+
+Connecting to the wallet from Python¶
+There are two functions for this:
+-
+
- Connecting to local verge instance +
Use the function connect_to_local(). This automagically +sorts out the connection to a verge process running on the current machine, +for the current user.
+++conn = vergerpc.connect_to_local() +
+- Connecting to a remote verge instance +
Use the function connect_to_remote(). For this function +it is neccesary to explicitly specify a hostname and port to connect to, and +to provide user credentials for logging in.
+++conn = vergerpc.connect_to_remote('foo', 'bar', host='payments.yoyodyne.com', port=8332) +
+
+
+How to use the API¶
+For basic sending and receiving of payments, the four most important methods are
+-
+
- Getting the current balance +
Use the method getbalance() to get the current server balance.
+++print "Your balance is %f" % (conn.getbalance(),) +
+- Check a customer address for validity and get information about it +
This can be done with the method validateaddress().
+++rv = conn.validateaddress(foo) +if rv.isvalid: + print "The address that you provided is valid" +else: + print "The address that you provided is invalid, please correct" +
+- Sending payments +
The method sendtoaddress() sends a specified +amount of coins to a specified address.
+++conn.sendtoaddress("msTGAm1ApjEJfsWfAaRVaZHRm26mv5GL73", 20.0) +
+- Get a new address for accepting payments +
To accept payments, use the method getnewaddress() +to generate a new address. Give this address to the customer and store it in a safe place, to be able to check +when the payment to this address has been made.
+++pay_to = conn.getnewaddress() +print "We will ship the pirate sandwidth after payment of 200 coins to ", pay_to +
+- Check how much has been received at a certain address +
The method getreceivedbyaddress() +returns how many verges have been received at a certain address. Together with the +previous function, this can be used to check whether a payment has been made +by the customer.
+++amount = conn.getreceivedbyaddress(pay_to) +if amount > 200.0: + print "Thanks, your sandwidth will be prepared and shipped." +
+
+
+The account API¶
+More advanced usage of verge allows multiple accounts within one wallet. This +can be useful if you are writing software for a bank, or +simply want to have a clear separation between customers payments.
+For this, see the Account API documentation.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/vergerpc.connection.html b/doc/vergerpc.connection.html
new file mode 100644
index 0000000..e76c8ee
--- /dev/null
+++ b/doc/vergerpc.connection.html
@@ -0,0 +1,690 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ vergerpc.config — Utilities for reading verge configuration files¶
+Utilities for reading verge configuration files.
+-
+
- +vergerpc.config.read_config_file(filename)¶ +
Read a simple '='-delimited config file. +Raises IOError if unable to open file, or ValueError +if an parse error occurs.
+
-
+
- +vergerpc.config.read_default_config(filename=None)¶ +
Read verge default configuration from the current user’s home directory.
+Arguments:
+-
+
- filename: Path to a configuration file in a non-standard location (optional) +
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/vergerpc.data.html b/doc/vergerpc.data.html
new file mode 100644
index 0000000..8a222ec
--- /dev/null
+++ b/doc/vergerpc.data.html
@@ -0,0 +1,249 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ vergerpc.connection — Connect to VERGE server via JSON-RPC¶
+Connect to VERGE server via JSON-RPC.
+-
+
- +class vergerpc.connection.VERGEConnection(user, password, host='localhost', port=20102, use_https=False)¶ +
Bases: builtins.object
+A VERGEConnection object defines a connection to a verge server. +It is a thin wrapper around a JSON-RPC API connection.
+Arguments to constructor:
+-
+
- user – Authenticate as user. +
- password – Authentication password. +
- host – VERGE JSON-RPC host. +
- port – VERGE JSON-RPC port. +
-
+
- +backupwallet(destination)¶ +
Safely copies wallet.dat to destination, which can be a directory or a path +with filename.
+Arguments: +- destination – directory or path with filename to backup wallet to.
+
-
+
- +createrawtransaction(inputs, outputs)¶ +
Creates a raw transaction spending given inputs +(a list of dictionaries, each containing a transaction id and an output number), +sending to given address(es).
+Returns hex-encoded raw transaction.
+Example usage: +>>> conn.createrawtransaction(
++
+-
+
- [{“txid”: “a9d4599e15b53f3eb531608ddb31f48c695c3d0b3538a6bda871e8b34f2f430c”, +
- “vout”: 0}], +
{“DkZBYBiq6DNoQEKakpMJegyDbw2YiNQnHT”:50})
+Arguments:
+-
+
inputs – A list of {“txid”: txid, “vout”: n} dictionaries.
+
+-
+
- outputs – A dictionary mapping (public) addresses to the amount +
they are to be paid.
+
+
+
-
+
- +decoderawtransaction(hexstring)¶ +
Produces a human-readable JSON object for a raw transaction.
+Arguments:
+-
+
- hexstring – A hex string of the transaction to be decoded. +
-
+
- +dumpprivkey(address)¶ +
Returns the private key belonging to <address>.
+Arguments:
+-
+
- address – VERGE address whose private key should be returned. +
-
+
- +getaccount(vergeaddress)¶ +
Returns the account associated with the given address.
+Arguments:
+-
+
- vergeaddress – VERGE address to get account for. +
-
+
- +getaccountaddress(account)¶ +
Returns the current verge address for receiving payments to an account.
+Arguments:
+-
+
- account – Account for which the address should be returned. +
-
+
- +getaddressesbyaccount(account)¶ +
Returns the list of addresses for the given account.
+Arguments:
+-
+
- account – Account to get list of addresses for. +
-
+
- +getbalance(account=None, minconf=None)¶ +
Get the current balance, either for an account or the total server balance.
+Arguments: +- account – If this parameter is specified, returns the balance in the account. +- minconf – Minimum number of confirmations required for transferred balance.
+
-
+
- +getblock(hash)¶ +
Returns information about the given block hash.
+
-
+
- +getblockcount()¶ +
Returns the number of blocks in the longest block chain.
+
-
+
- +getblockhash(index)¶ +
Returns hash of block in best-block-chain at index.
++
++ + + Parameters: index – index ob the block +
-
+
- +getblocknumber()¶ +
Returns the block number of the latest block in the longest block chain. +Deprecated. Use getblockcount instead.
+
-
+
- +getconnectioncount()¶ +
Returns the number of connections to other nodes.
+
-
+
- +getdifficulty()¶ +
Returns the proof-of-work difficulty as a multiple of the minimum difficulty.
+
-
+
- +getgenerate()¶ +
Returns True or False, depending on whether generation is enabled.
+
-
+
- +gethashespersec()¶ +
Returns a recent hashes per second performance measurement while generating.
+
-
+
- +getinfo()¶ +
Returns an ServerInfo object containing various state info.
+
-
+
- +getmininginfo()¶ +
Returns an MiningInfo object containing various +mining state info.
+
-
+
- +getnewaddress(account=None)¶ +
Returns a new verge address for receiving payments.
+Arguments:
+-
+
- account – If account is specified (recommended), it is added to the address book +so that payments received with the address will be credited to it. +
-
+
- +getrawtransaction(txid, verbose=True)¶ +
Get transaction raw info
+Arguments:
+-
+
- txid – Transactiond id for which the info should be returned. +
- verbose – If False, return only the “hex” of the transaction. +
-
+
- +getreceivedbyaccount(account, minconf=1)¶ +
Returns the total amount received by addresses with an account in transactions with +at least a certain number of confirmations.
+Arguments:
+-
+
- account – Account to query for total amount. +
- minconf – Number of confirmations to require, defaults to 1. +
-
+
- +getreceivedbyaddress(vergeaddress, minconf=1)¶ +
Returns the total amount received by a verge address in transactions with at least a +certain number of confirmations.
+Arguments:
+-
+
- vergeaddress – Address to query for total amount. +
- minconf – Number of confirmations to require, defaults to 1. +
-
+
- +gettransaction(txid)¶ +
Get detailed information about transaction
+Arguments:
+-
+
- txid – Transactiond id for which the info should be returned +
-
+
- +gettxout(txid, index, mempool=True)¶ +
Returns details about an unspent transaction output (UTXO)
+Arguments:
+-
+
- txid – Transactiond id for which the info should be returned. +
- index – The output index. +
- mempool – Add memory pool transactions. +
-
+
- +getwork(data=None)¶ +
Get work for remote mining, or submit result. +If data is specified, the server tries to solve the block +using the provided data and returns True if it was successful. +If not, the function returns formatted hash data (WorkItem) +to work on.
+Arguments:
+-
+
- data – Result from remote mining. +
-
+
- +importprivkey(privkey, acct='', rescan=True)¶ +
import private key <privkey> to account [acct], optionally rescanning blockchain .
+Arguments:
+-
+
- privkey – private key to import. +
- [acct] – name of account to associate with private key +
- [rescan] – rescan blockchain for transcations containing altcoin address associated with privkey +
-
+
- +keypoolrefill()¶ +
Fills the keypool, requires wallet passphrase to be set.
+
-
+
- +listaccounts(minconf=1, as_dict=False)¶ +
Returns a list of account names.
+Arguments:
+-
+
- minconf – Minimum number of confirmations before payments are included. +
- as_dict – Returns a dictionary of account names, with their balance as values. +
-
+
- +listreceivedbyaccount(minconf=1, includeempty=False)¶ +
Returns a list of accounts.
+Each account is represented with a AccountInfo object.
+Arguments:
+-
+
- minconf – Minimum number of confirmations before payments are included. +
- includeempty – Whether to include addresses that haven’t received any payments. +
-
+
- +listreceivedbyaddress(minconf=1, includeempty=False)¶ +
Returns a list of addresses.
+Each address is represented with a AddressInfo object.
+Arguments:
+-
+
- minconf – Minimum number of confirmations before payments are included. +
- includeempty – Whether to include addresses that haven’t received any payments. +
-
+
- +listtransactions(account=None, count=10, from_=0, address=None)¶ +
Returns a list of the last transactions for an account.
+Each transaction is represented with a TransactionInfo object.
+Arguments:
+-
+
-
+
- account – Account to list transactions from. Return transactions from +
all accounts if None.
+
+
+count – Number of transactions to return.
+
+from_ – Skip the first <from_> transactions.
+
+address – Receive address to consider
+
+
-
+
- +listunspent(minconf=1, maxconf=999999)¶ +
Returns a list of unspent transaction inputs in the wallet.
+Arguments:
+-
+
- minconf – Minimum number of confirmations required to be listed. +
- maxconf – Maximal number of confirmations allowed to be listed. +
-
+
- +move(fromaccount, toaccount, amount, minconf=1, comment=None)¶ +
Move from one account in your wallet to another.
+Arguments:
+-
+
- fromaccount – Source account name. +
- toaccount – Destination account name. +
- amount – Amount to transfer. +
- minconf – Minimum number of confirmations required for transferred balance. +
- comment – Comment to add to transaction log. +
-
+
- +sendfrom(fromaccount, tovergeaddress, amount, minconf=1, comment=None, comment_to=None)¶ +
Sends amount from account’s balance to vergeaddress. This method will fail +if there is less than amount verges with minconf confirmations in the account’s +balance (unless account is the empty-string-named default account; it +behaves like the sendtoaddress method). Returns transaction ID on success.
+Arguments:
+-
+
- fromaccount – Account to send from. +
- tovergeaddress – VERGE address to send to. +
- amount – Amount to send (float, rounded to the nearest 0.01). +
- minconf – Minimum number of confirmations required for transferred balance. +
- comment – Comment for transaction. +
- comment_to – Comment for to-address. +
-
+
- +sendmany(fromaccount, todict, minconf=1, comment=None)¶ +
Sends specified amounts from account’s balance to vergeaddresses. This method will fail +if there is less than total amount verges with minconf confirmations in the account’s +balance (unless account is the empty-string-named default account; Returns transaction ID +on success.
+Arguments:
+-
+
- fromaccount – Account to send from. +
- todict – Dictionary with VERGE addresses as keys and amounts as values. +
- minconf – Minimum number of confirmations required for transferred balance. +
- comment – Comment for transaction. +
-
+
- +sendtoaddress(vergeaddress, amount, comment=None, comment_to=None)¶ +
Sends amount from the server’s available balance to vergeaddress.
+Arguments:
+-
+
- vergeaddress – VERGE address to send to. +
- amount – Amount to send (float, rounded to the nearest 0.00000001). +
- minconf – Minimum number of confirmations required for transferred balance. +
- comment – Comment for transaction. +
- comment_to – Comment for to-address. +
-
+
- +setaccount(vergeaddress, account)¶ +
Sets the account associated with the given address.
+Arguments:
+-
+
- vergeaddress – VERGE address to associate. +
- account – Account to associate the address to. +
-
+
- +setgenerate(generate, genproclimit=None)¶ +
Enable or disable generation (mining) of coins.
+Arguments:
+-
+
- generate – is True or False to turn generation on or off. +
- genproclimit – Number of processors that are used for generation, -1 is unlimited. +
-
+
- +signmessage(address, message)¶ +
Sign messages, returns the signature
++
++ + + Parameters: -
+
- address (str or unicode) – VERGE address used to sign a message +
- message (str or unicode) – The message to sign +
Return type: unicode
+
-
+
- +signrawtransaction(hexstring, previous_transactions=None, private_keys=None)¶ +
Sign inputs for raw transaction (serialized, hex-encoded).
+-
+
- Returns a dictionary with the keys: +
- “hex”: raw transaction with signature(s) (hex-encoded string) +“complete”: 1 if transaction has a complete set of signature(s), 0 if not +
Arguments:
+-
+
hexstring – A hex string of the transaction to sign.
+
+-
+
- previous_transactions – A (possibly empty) list of dictionaries of the form: +
{“txid”: txid, “vout”: n, “scriptPubKey”: hex, “redeemScript”: hex}, representing +previous transaction outputs that this transaction depends on but may not yet be +in the block chain.
+
+
+-
+
- private_keys – A (possibly empty) list of base58-encoded private +
keys that, if given, will be the only keys used to sign the transaction.
+
+
+
-
+
- +stop()¶ +
Stop verge server.
+
-
+
- +validateaddress(validateaddress)¶ +
Validate a verge address and return information for it.
+The information is represented by a AddressValidation object.
+Arguments: – Address to validate.
+-
+
- validateaddress +
-
+
- +verifymessage(address, signature, message)¶ +
Verify a signed message
++
++ + + Parameters: -
+
- address (str or unicode) – VERGE address used to sign a message +
- signature (unicode) – The signature +
- message (str or unicode) – The message to sign +
Return type: bool
+
-
+
- +walletlock()¶ +
Removes the wallet encryption key from memory, locking the wallet. +After calling this method, you will need to call walletpassphrase +again before being able to call any methods which require the wallet +to be unlocked.
+
-
+
- +walletpassphrase(passphrase, timeout, dont_raise=False)¶ +
Stores the wallet decryption key in memory for <timeout> seconds.
+-
+
passphrase – The wallet passphrase.
+
+-
+
- timeout – Time in seconds to keep the wallet unlocked +
(by keeping the passphrase in memory).
+
+
+-
+
- dont_raise – instead of raising ~vergerpc.exceptions.WalletPassphraseIncorrect +
return False.
+
+
+
-
+
- +walletpassphrasechange(oldpassphrase, newpassphrase, dont_raise=False)¶ +
Changes the wallet passphrase from <oldpassphrase> to <newpassphrase>.
+Arguments:
+-
+
-
+
- dont_raise – instead of raising ~vergerpc.exceptions.WalletPassphraseIncorrect +
return False.
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/vergerpc.exceptions.html b/doc/vergerpc.exceptions.html
new file mode 100644
index 0000000..48eed5f
--- /dev/null
+++ b/doc/vergerpc.exceptions.html
@@ -0,0 +1,282 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ vergerpc.data — VERGE RPC service, data objects¶
+VERGE RPC service, data objects.
+-
+
- +class vergerpc.data.AccountInfo(*args_t, **args_d)¶ +
Bases: vergerpc.util.DStruct
+Information object returned by listreceivedbyaccount().
+-
+
- account – The account of the receiving address. +
- amount – Total amount received by the address. +
- confirmations – Number of confirmations of the most recent transaction included. +
-
+
- +class vergerpc.data.AddressInfo(*args_t, **args_d)¶ +
Bases: vergerpc.util.DStruct
+Information object returned by listreceivedbyaddress().
+-
+
- address – Receiving address. +
- account – The account of the receiving address. +
- amount – Total amount received by the address. +
- confirmations – Number of confirmations of the most recent transaction included. +
-
+
- +class vergerpc.data.AddressValidation(*args_t, **args_d)¶ +
Bases: vergerpc.util.DStruct
+Information object returned by validateaddress().
+-
+
- isvalid – Validatity of address (True or False). +
- ismine – True if the address is in the server’s wallet. +
- address – VERGE address. +
-
+
- +class vergerpc.data.MiningInfo(*args_t, **args_d)¶ +
Bases: vergerpc.util.DStruct
+Information object returned by getmininginfo().
+-
+
- blocks – Number of blocks. +
- currentblocksize – Size of current block. +
- currentblocktx – Number of transactions in current block. +
- difficulty – Current generating difficulty. +
- errors – Number of errors. +
- generate – True if generation enabled, False if not. +
- genproclimit – Processor limit for generation. +
- hashespersec – Number of hashes per second (if generation enabled). +
- pooledtx – Number of pooled transactions. +
- testnet – True if connected to testnet, False if on real network. +
-
+
- +class vergerpc.data.ServerInfo(*args_t, **args_d)¶ +
Bases: vergerpc.util.DStruct
+Information object returned by getinfo().
+-
+
errors – Number of errors.
+
+blocks – Number of blocks.
+
+paytxfee – Amount of transaction fee to pay.
+
+keypoololdest – Oldest key in keypool.
+
+genproclimit – Processor limit for generation.
+
+connections – Number of connections to other clients.
+
+difficulty – Current generating difficulty.
+
+testnet – True if connected to testnet, False if on real network.
+
+version – VERGE client version.
+
+proxy – Proxy configured in client.
+
+hashespersec – Number of hashes per second (if generation enabled).
+
+balance – Total current server balance.
+
+generate – True if generation enabled, False if not.
+
+-
+
- unlocked_until – Timestamp (seconds since epoch) after which the wallet +
will be/was locked (if wallet encryption is enabled).
+
+
+
-
+
- +class vergerpc.data.TransactionInfo(*args_t, **args_d)¶ +
Bases: vergerpc.util.DStruct
+Information object returned by listtransactions().
+-
+
- account – account name. +
- address – the address verges were sent to, or received from. +
- category – will be generate, send, receive, or move. +
- amount – amount of transaction. +
- fee – Fee (if any) paid (only for send transactions). +
- confirmations – number of confirmations (only for generate/send/receive). +
- txid – transaction ID (only for generate/send/receive). +
- otheraccount – account funds were moved to or from (only for move). +
- message – message associated with transaction (only for send). +
- to – message-to associated with transaction (only for send). +
-
+
- +class vergerpc.data.WorkItem(*args_t, **args_d)¶ +
Bases: vergerpc.util.DStruct
+Information object returned by getwork().
+-
+
- midstate – Precomputed hash state after hashing the first half of the data. +
- data – Block data. +
- hash1 – Formatted hash buffer for second hash. +
- target – Little endian hash target. +
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/vergerpc.html b/doc/vergerpc.html
new file mode 100644
index 0000000..0a7f4d5
--- /dev/null
+++ b/doc/vergerpc.html
@@ -0,0 +1,140 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ vergerpc.exceptions — Exception definitions¶
+Exception definitions.
+-
+
- +exception vergerpc.exceptions.ClientException(error)¶ +
Bases: vergerpc.exceptions.VERGEException
+P2P network error. +This exception is never raised but functions as a superclass +for other P2P client exceptions.
+
-
+
- +exception vergerpc.exceptions.VERGEException(error)¶ +
Bases: builtins.Exception
+Base class for exceptions received from VERGE server.
+-
+
- code – Error code from verged. +
-
+
- +exception vergerpc.exceptions.DownloadingBlocks(error)¶ +
Bases: vergerpc.exceptions.ClientException
+Client is still downloading blocks.
+
-
+
- +exception vergerpc.exceptions.InsufficientFunds(error)¶ +
Bases: vergerpc.exceptions.WalletError
+Insufficient funds to complete transaction in wallet or account
+
-
+
- +exception vergerpc.exceptions.InvalidAccountName(error)¶ +
Bases: vergerpc.exceptions.WalletError
+Invalid account name
+
-
+
- +exception vergerpc.exceptions.InvalidAddressOrKey(error)¶ +
Bases: vergerpc.exceptions.VERGEException
+Invalid address or key.
+
-
+
- +vergerpc.exceptions.InvalidAmount¶ +
alias of JSONTypeError
+
-
+
- +exception vergerpc.exceptions.InvalidParameter(error)¶ +
Bases: vergerpc.exceptions.VERGEException
+Invalid parameter provided to RPC call.
+
-
+
- +vergerpc.exceptions.InvalidTransactionID¶ +
alias of InvalidAddressOrKey
+
-
+
- +exception vergerpc.exceptions.JSONTypeError(error)¶ +
Bases: vergerpc.exceptions.VERGEException
+Unexpected type was passed as parameter
+
-
+
- +exception vergerpc.exceptions.KeypoolRanOut(error)¶ +
Bases: vergerpc.exceptions.WalletError
+Keypool ran out, call keypoolrefill first
+
-
+
- +exception vergerpc.exceptions.NotConnected(error)¶ +
Bases: vergerpc.exceptions.ClientException
+Not connected to any peers.
+
-
+
- +exception vergerpc.exceptions.OutOfMemory(error)¶ +
Bases: vergerpc.exceptions.VERGEException
+Out of memory during operation.
+
-
+
- +exception vergerpc.exceptions.SafeMode(error)¶ +
Bases: vergerpc.exceptions.VERGEException
+Operation denied in safe mode (run verged with -disablesafemode).
+
-
+
- +vergerpc.exceptions.SendError¶ +
alias of WalletError
+
-
+
- +exception vergerpc.exceptions.TransportException(msg, code=None, protocol=None, raw_detail=None)¶ +
Bases: builtins.Exception
+Class to define transport-level failures.
+
-
+
- +exception vergerpc.exceptions.WalletAlreadyUnlocked(error)¶ +
Bases: vergerpc.exceptions.WalletError
+Wallet is already unlocked
+
-
+
- +exception vergerpc.exceptions.WalletEncryptionFailed(error)¶ +
Bases: vergerpc.exceptions.WalletError
+Failed to encrypt the wallet
+
-
+
- +exception vergerpc.exceptions.WalletError(error)¶ +
Bases: vergerpc.exceptions.VERGEException
+Unspecified problem with wallet (key not found etc.)
+
-
+
- +exception vergerpc.exceptions.WalletPassphraseIncorrect(error)¶ +
Bases: vergerpc.exceptions.WalletError
+The wallet passphrase entered was incorrect
+
-
+
- +exception vergerpc.exceptions.WalletUnlockNeeded(error)¶ +
Bases: vergerpc.exceptions.WalletError
+Enter the wallet passphrase with walletpassphrase first
+
-
+
- +exception vergerpc.exceptions.WalletWrongEncState(error)¶ +
Bases: vergerpc.exceptions.WalletError
+Command given in wrong wallet encryption state (encrypting an encrypted wallet etc.)
+
-
+
- +vergerpc.exceptions.wrap_exception(error)¶ +
Convert a JSON error object to a more specific VERGE exception.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/doc/vergerpc.util.html b/doc/vergerpc.util.html
new file mode 100644
index 0000000..0972c5a
--- /dev/null
+++ b/doc/vergerpc.util.html
@@ -0,0 +1,105 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ vergerpc — Convenience functions¶
+verge-python - Easy-to-use VERGE API client
+-
+
- +vergerpc.connect_to_local(filename=None)¶ +
Connect to default VERGE instance owned by this user, on this machine.
+Returns a VERGEConnection object.
+Arguments:
++
+-
+
- filename: Path to a configuration file in a non-standard location (optional) +
-
+
- +vergerpc.connect_to_remote(user, password, host='localhost', port=22555, use_https=False)¶ +
Connect to remote or alternative local verge client instance.
+Returns a VERGEConnection object.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/release_process.txt b/release_process.txt
new file mode 100644
index 0000000..850eb10
--- /dev/null
+++ b/release_process.txt
@@ -0,0 +1,29 @@
+Release process
+
+- Update Changelog (using git history output from dist-tools/changelog.sh)
+
+- Change version numbers in setup.py and sphinx/source/conf.py
+
+- Commit
+
+- Make tag and upload to github
+
+ - git tag -a vX.X
+ - git push origin vX.X
+
+- Run make in doc/
+
+- Update documentation on github
+
+ - git checkout gh_pages
+ - rm -r doc
+ - mkdir doc
+ - cp -r sphinx/build/html/* doc/
+ - git add doc
+ - git commit -a
+ - git push origin gh-pages:gh-pages
+
+- Upload to pypi
+
+ - python setup.py sdist upload
+
diff --git a/setup.py b/setup.py
new file mode 100644
index 0000000..05c9b86
--- /dev/null
+++ b/setup.py
@@ -0,0 +1,21 @@
+from setuptools import setup, find_packages
+setup(
+ name='verge-python',
+ version='0.1.3',
+ description='Friendly VERGE JSON-RPC API binding for Python',
+ long_description='This package allows performing commands such as listing the current balance'
+ ' and sending coins to the original client from Python. The communication with the'
+ ' client happens over JSON-RPC.',
+ url='https://github.com/vergecurrency/verge-python',
+ classifiers=[
+ 'Development Status :: 4 - Beta',
+ 'Environment :: Console',
+ 'Environment :: Web Environment',
+ 'Intended Audience :: Developers',
+ 'Programming Language :: Python',
+ 'License :: OSI Approved :: MIT License',
+ 'Topic :: Office/Business :: Financial'
+ ],
+ packages=find_packages("src"),
+ package_dir={'': 'src'}
+)
diff --git a/sphinx/Makefile b/sphinx/Makefile
new file mode 100644
index 0000000..60830db
--- /dev/null
+++ b/sphinx/Makefile
@@ -0,0 +1,89 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
+
+help:
+ @echo "Please use \`make
+
+
+
+
+
+
+
+
+
+
+
+
+ vergerpc.util — Generic utilities used by verge client library¶
+Generic utilities used by verge client library.
+-
+
- +class vergerpc.util.DStruct(*args_t, **args_d)¶ +
Bases: builtins.object
+Simple dynamic structure, like collections.namedtuple but more flexible +(and less memory-efficient)
+
\ + Sort by:\ + best rated\ + newest\ + oldest\ +
\ +\ +
Add a comment\ + (markup):
\ +