bmwant / python-dogecoin Goto Github PK

This is a fork of a dogecoin-python library focused on a Python 3 support only. Note that you are looking for python-dogecoin version on PyPI instead of original dogecoin-python.

This package allows performing commands such as listing the current balance and sending coins to the Satoshi (original) client from Python. The communication with the client happens over JSON-RPC.

📖 Documentation for the library can be found here.

🍋 This project uses podmena library to add fancy icons to commit messages.

$ pip install python-dogecoin

Connect to blockchain daemon locally and make a simple request

"""
Checks whether address provided is a valid Dogecoin wallet
"""
import dogecoinrpc

client = dogecoinrpc.connect_to_local()
address = 'D6cobCBMtRoJNw8kxAWJ8GtRbbaxSAB37u'
result = conn.validateaddress(address)
print(result)

For other examples and code snippets check documentation.

pyenv is used to easily create virtual environment for the development. Use pyenv-installer to quickly setup it locally.

$ pyenv virtualenv 3.8.1 python-dogecoin
$ pyenv activate python-dogecoin
$ pip install --upgrade pip
$ pip install -e .

Formatting your code after adding changes

$ pyenv activate python-dogecoin
$ pip install -e ".[dev]"
$ make format

To launch basic set of unittests

$ pyenv activate python-dogecoin
$ pip install -e ".[test]"
$ pytest -sv tests/
$ flake8 .  # lint code to spot any other errors

To launch integration tests you need Dogecoin server to be up and running and configured to use testnet.

$ pytest -sv tests/ --run-integration

If you love Dogecoin and want to support the project you can send coins to this wallet

D7DA74qzZUyh9cctCxWovPTEovUSjGzL2S

🐕 🚀 🌕