https://github.com/steemit/steem-python

The official Python (3) library for the Steem Blockchain.
https://github.com/steemit/steem-python

steem steem-blockchain steemit

Last synced: 16 days ago
JSON representation

The official Python (3) library for the Steem Blockchain.

• Host: GitHub
• URL: https://github.com/steemit/steem-python
• Owner: steemit
• License: mit
• Created: 2017-03-13T15:37:52.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-03-30T10:51:52.000Z (over 5 years ago)
• Last Synced: 2024-08-31T08:22:15.516Z (3 months ago)
• Topics: steem, steem-blockchain, steemit
• Language: Python
• Homepage: https://steem.io
• Size: 914 KB
• Stars: 153
• Watchers: 47
• Forks: 99
• Open Issues: 87
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-steem - steem-python - The official Python (3) library for the Steem Blockchain. (SDKs)

README

        
# Official Python STEEM Library

`steem-python` is the official Steem library for Python. It comes with a

BIP38 encrypted wallet and a practical CLI utility called `steempy`.

This library currently works on Python 2.7, 3.5 and 3.6. Python 3.3 and 3.4 support forthcoming.

# Installation

With pip:

```

pip3 install steem      # pip install steem for 2.7

```

From Source:

```

git clone https://github.com/steemit/steem-python.git

cd steem-python

python3 setup.py install        # python setup.py install for 2.7

```

## Homebrew Build Prereqs

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"

```

# CLI tools bundled

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 .`

# Documentation

Documentation is available at **http://steem.readthedocs.io**

# Tests

Some tests are included.  They can be run via:

* `python setup.py test`

# TODO

* more unit tests

* 100% documentation coverage, consistent documentation

* migrate to click CLI library

# Notice

This library is *under development*.  Beware.