pycoin icon indicating copy to clipboard operation
pycoin copied to clipboard

readme inconsistent with master code

Open xuanzhui opened this issue 6 years ago • 3 comments

Readme says pycoin.key.Key has a param netcode, but there is no such param in method __init__

xuanzhui avatar May 08 '18 07:05 xuanzhui

Same with the recipes section.. Looks like the module pycoin.ui.ui doesn't exist, so the functions are unavailable..

from pycoin.symbols.btc import network as BitcoinMainnet

address_for_script = BitcoinMainnet.ui.address_for_p2s
script_for_address = BitcoinMainnet.ui.script_for_address

Same with the BIP32Node.from_hwif() from 1_create_address.py

It's clear to me the authors actively maintain the project, but getting started isn't easy at all when documentation is out of date :/

afk11 avatar Aug 23 '18 15:08 afk11

It's true, the documentation is out of date and things are changing quickly. My apologies.

As you've noticed @afk11, everything is moving to under "network" so you use drill down from there to get submodules you need. Unfortunately not everything is in its final place yet.

richardkiss avatar Aug 24 '18 02:08 richardkiss

@richardkiss thanks for the message!

It's probably somewhat my fault for cloning master and not a tagged branch. But one solution could be to run the recipe scripts in travis so they're tested on each push.

To facilitate this we could specify default value for the commands arguments, and then use something like this to test.

#!/bin/bash

function runDirPy()
{
    echo "Checking python files in ${1}"
    for i in $1/*.py; do
        python $i > /dev/null
        if [ $? -ne 0 ]; then
            echo "Error running example code: $i";
            exit -1
        fi;
    done
}

runDirPy recipes/multisig;

If you like I could PR this after getting the existing ones into shape?

afk11 avatar Aug 25 '18 15:08 afk11