steem-python is the official Steem library for Python. It comes with a
BIP38 encrypted wallet and a practical CLI utility called steempy.
Currently only python3 is supported. Python2 support is planned.
Install pipenv first if you don't have it:
pip3 install --upgrade --user pipenv
Then, install steem-python using it:
git clone https://github.com/steemit/steem-python.git
cd steem-python
pipenv install --three --dev
pipenv install .
git clone https://github.com/steemit/steem-python.git
cd steem-python
pip3 install --user .
Note that installation using pip3 requires that the pipenv module be installed to parse the requirements out of the Pipfile so that pip3 can do the install. If you get an error about pipenv not being found, you can resolve it with a pip3 install --upgrade --user pipenv, then the install with pip3 will work as usual.
If you're on a mac, you may need to do the following first:
brew install openssl
export CFLAGS="-I$(brew --prefix openssl)/include $CFLAGS"
export LDFLAGS="-L$(brew --prefix openssl)/lib $LDFLAGS"
The library comes with a few console scripts.
steempy:- rudimentary blockchain CLI (needs some TLC and more TLAs)
steemtail:- useful for e.g.
steemtail -f -j | jq --unbuffered --sort-keys .
- useful for e.g.
Documentation is available at http://steem.readthedocs.io
Some tests are included. They can be run via either docker or vagrant, for reproducibility, e.g.:
docker build .
or
vagrant up
- fix parts that were copied from python-graphenelib that only support python3 to support python2 as well
- more unit tests
- 100% documentation coverage, consistent documentation
- migrate to click CLI library
This library is under development. Beware.