view DOCS.md @ 18:2f7085f0ce9d default tip

Move to mercurial
author Dennis C. M. <dennis@denniscm.com>
date Wed, 04 Jun 2025 09:34:56 +0100
parents 381b13eff3a6
children
line wrap: on
line source

# Table of Contents

1.  [Installation](#orgdb921af) 2.  [Usage](#org9fd02ba) 1.
[Example](#orgfc928cc)

<a id="orgdb921af"></a>

# Installation

    pip install bitcaviar


<a id="org9fd02ba"></a>

# Usage

    from bitcaviar import config
    
    bitcoin = config.Bitcoin(
        cli_dir='your/dir/to/bitcoin-cli', 
        data_dir='/where/is/the/blockchain'
    )


<a id="orgfc928cc"></a>

## Example

Get the number of blocks in the blockchain.

    from bitcaviar import config
    from bitcaviar import blockchain
    
    
    def main():
        bitcoin = config.Bitcoin(
    	cli_dir='bitcoin-cli', 
    	data_dir='/Users/dennis/Bitcoin'
        )
    
        block_count = blockchain.get_block_count(bitcoin=bitcoin)
    
        print(block_count)
    
    
    if __name__ == '__main__':
        main()