Skip to main content

Gabriel Cardona's Bitbox ported to Python

Project description

Bitbox-py: A Python SDK for creating great Bitcoin Cash applications

Bitbox-py is the Python port of Gabriel Cardona's great Bitcoin Cash Javascript SDK Bitbox.

I ported Bitbox to Python to make Bitcoin Cash more accessible to developers and therefore to the world.

Usage

Install Bitbox-py using Pip:

pip install bitbox-py

Documentation

Everything is basically the same as Bitbox-sdk, except methods are not using camelCase in order to fit with Python's style.

You can refer to the official Documentation.

Example:

Javascript:

import { BITBOX } from 'bitbox-sdk'

let bitbox = new BITBOX();

let result = bitbox.Address.toLegacyAddress('bitcoincash:qrxjktfjdse3ll0ttrll20gykuhqjw764queg3w2tj');

console.log(result);
// 1KhqFHWHUoJ72tuQCkhV1m1Sk7bXCiKJgN

Python:

import bitbox

result = bitbox.Address.to_legacy_address('bitcoincash:qrxjktfjdse3ll0ttrll20gykuhqjw764queg3w2tj')

print(result)
# 1KhqFHWHUoJ72tuQCkhV1m1Sk7bXCiKJgN

OR import by class:

from bitbox import Address

result = Address.to_legacy_address('bitcoincash:qrxjktfjdse3ll0ttrll20gykuhqjw764queg3w2tj')

print(result)
# 1KhqFHWHUoJ72tuQCkhV1m1Sk7bXCiKJgN

Contributing

You can find the instructions for contributing on CONTRIBUTING.md.

Features you can add that aren't implemented yet:

  • ECPair utilities (fromWIF, fromPublicKey etc)
  • HDNode methods (fromSeed, derive etc)
  • Schnorr utilities

Notes and credits

  • Gabriel Cardona for creating the original Javascript Bitbox-sdk, and for inspiring me everyday!
  • Bitcoin.com for enabling millions of individuals to use an uncensorable peer-to-peer cash system everyday.
  • Rosco Kalis for encouraging me to port Bitbox to Python.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for bitbox-py, version 0.0.6
Filename, size File type Python version Upload date Hashes
Filename, size bitbox_py-0.0.6-py3-none-any.whl (13.1 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size bitbox-py-0.0.6.tar.gz (8.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page