Skip to main content

A simple, yet secure Bitcoin utility library

Project description

oogway

oogway is a simple, yet secure Bitcoin utility library for Python.

Supported Versions Build License

>>> from oogway import Key
>>> 
>>> key = Key(mnemonic_strength=256, passphrase="bitcoin")
>>> 
>>> key.mnemonic
'hungry believe click napkin aerobic make skirt early vibrant suffer trumpet pupil prize ecology bleak citizen absent chief feed skin vast enter this female'
>>> 
>>> key.wif # wif private key
'5JnkYopgMsFQtsUkZ3WkmacsBGk3JouYpUNpudHDp6VW3QyyJEr'
>>> 
>>> key.address("Bech32") # Bech32 (segwit) address
'bc1qt8felv4tn8a4kzjqle4r5scerwda9pmmaza95xyp22wtnccxhz7snrumvq'
>>> 
>>> key.pubkey("unc") # uncompressed public key
'041d5e3b36948035f6cee1d349e02fa3c8cb2f07c1aa3692abfe2699e7693423162a184b8bf58aec320368ddb58ff16705f3ecfed23f8cc080b1225a0e90a74c6c'

The library allows you to easily generate Bitcoin keypairs or create, sign and broadcast transactions. It can also do other things such as validate addresses (cryptographically) or safely convert and operate between bitcoin units. oogway also supports multisig.

oogway also has a built-in CLI to simplify some tasks:

$ oogway validate 3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy 1BWJVUqZKbs6nXbsrh0boyjckqdoKIk5wa

[VALID | P2SH] 1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2
[INVALID] 1BWJVUqZKbs6nXbsrh0boyjckqdoKIk5wa

Installation


$ pip install oogway

Documentation


Read the library documentation at 6conf.com.

The documentation is automatically updated after each commit to the master branch. Every pull request adding or modifying features must contain a documentation update (Markdown).

Docs are generated using VuePress. To run the docs locally, do:

$ cd docs/
$ npm install
$ npm run docs:dev

Contribute


Add yourself to authors and make a pull request on a new branch. Update the documentation if necessary.

Notes


  • oogway is one of many Python Bitcoin libraries. It was heavily inspired by ofek/bit. oogway tries to focus on security while remaining simple and accessible.

Project details


Download files

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

Source Distribution

oogway-0.7.1.tar.gz (45.9 kB view details)

Uploaded Source

Built Distribution

oogway-0.7.1-py3-none-any.whl (57.5 kB view details)

Uploaded Python 3

File details

Details for the file oogway-0.7.1.tar.gz.

File metadata

  • Download URL: oogway-0.7.1.tar.gz
  • Upload date:
  • Size: 45.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.7

File hashes

Hashes for oogway-0.7.1.tar.gz
Algorithm Hash digest
SHA256 6805b2e3a96b32e1c346d292412620c44b2028724b7f0f80ed5e3a166e3070ed
MD5 017ad6e0257595cd4c8d62ac879d8a09
BLAKE2b-256 c43b5a0eb06183516f0b987db662d02c4486b84d02870faf5201cfaa169b08f8

See more details on using hashes here.

File details

Details for the file oogway-0.7.1-py3-none-any.whl.

File metadata

  • Download URL: oogway-0.7.1-py3-none-any.whl
  • Upload date:
  • Size: 57.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.7

File hashes

Hashes for oogway-0.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 713740d1fa601ea98bcece91f6d78202de487f2485f64f8c54ae6e6e67c4ca81
MD5 8f021c499b4694e692f18f2e7870bccc
BLAKE2b-256 3c64a131b70a77e96ef87e700b669163993f4118769bb75569770f4cd0e212d5

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page