Mercurial > public > bitcaviar

changeset 8:f3b9cb1eadef 0.0.1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
add installation instructions
author Dennis Concepcion Martin <dennisconcepcionmartin@gmail.com>
date Sat, 09 Oct 2021 13:57:10 +0200
parents 4bf969ad1fb4
children 697630db10c8
files .idea/bitcaviar.iml README.md
diffstat 2 files changed, 13 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/.idea/bitcaviar.iml	Sat Oct 09 13:44:47 2021 +0200
+++ b/.idea/bitcaviar.iml	Sat Oct 09 13:57:10 2021 +0200
@@ -5,7 +5,7 @@
       <sourceFolder url="file://$MODULE_DIR$/../bitcaviar/src" isTestSource="false" />
       <excludeFolder url="file://$MODULE_DIR$/../bitcaviar/venv" />
     </content>
-    <orderEntry type="inheritedJdk" />
+    <orderEntry type="jdk" jdkName="Python 3.8 (venv)" jdkType="Python SDK" />
     <orderEntry type="sourceFolder" forTests="false" />
   </component>
 </module>
\ No newline at end of file
--- a/README.md	Sat Oct 09 13:44:47 2021 +0200
+++ b/README.md	Sat Oct 09 13:57:10 2021 +0200
@@ -2,6 +2,9 @@
 A simple Python wrapper for Bitcoin JSON-RPC API.
 
 ## Installation
+```bash
+pip install bitcaviar
+```
 
 ## Usage
 You should pass your `bitcoin-cli` directory and where you have the blockchain stored to each method.
@@ -9,7 +12,10 @@
 ```python
 from bitcaviar import config
 
-bitcoin = config.Bitcoin(cli_dir='your/dir/to/bitcoin-cli', data_dir='/where/is/the/blockchain')
+bitcoin = config.Bitcoin(
+    cli_dir='your/dir/to/bitcoin-cli', 
+    data_dir='/where/is/the/blockchain'
+)
 ```
 
 ### Example 1
@@ -21,7 +27,11 @@
 
 
 def main():
-    bitcoin = config.Bitcoin(cli_dir='bitcoin-cli', data_dir='/Users/dennis/Bitcoin')
+    bitcoin = config.Bitcoin(
+        cli_dir='bitcoin-cli', 
+        data_dir='/Users/dennis/Bitcoin'
+    )
+    
     block_count = blockchain.get_block_count(bitcoin=bitcoin)
 
     print(block_count)