Python Bitcoin Library
======================
Bitcoin cryptocurrency Library writen in Python.
Allows you to create a fully functional Bitcoin wallet with a single line of code.
Use this library to create and manage transactions, addresses/keys, wallets, mnemonic password phrases and blocks with
simple and straightforward Python code.
You can use this library at a high level and create and manage wallets from the command line or at a low level
and create your own custom made transactions, scripts, keys or wallets.
The BitcoinLib connects to various service providers automatically to update wallets, transaction and
blockchain information.
.. image:: https://github.com/1200wd/bitcoinlib/actions/workflows/unittests.yaml/badge.svg
:target: https://github.com/1200wd/bitcoinlib/actions/workflows/unittests.yaml
:alt: Unittests
.. image:: https://img.shields.io/pypi/v/bitcoinlib.svg
:target: https://pypi.org/pypi/bitcoinlib/
:alt: PyPi
.. image:: https://readthedocs.org/projects/bitcoinlib/badge/?version=latest
:target: http://bitcoinlib.readthedocs.io/en/latest/?badge=latest
:alt: RTD
.. image:: https://coveralls.io/repos/github/1200wd/bitcoinlib/badge.svg?branch=installation-documentation-update
:target: https://coveralls.io/github/1200wd/bitcoinlib?branch=master
:alt: Coveralls
Install
-------
Installed required packages
.. code-block:: bash
$ sudo apt install build-essential python3-dev libgmp3-dev
Then install using pip
.. code-block:: bash
$ pip install bitcoinlib
For more detailed installation instructions, how to install on other systems or troubleshooting please read https://bitcoinlib.readthedocs.io/en/latest/source/_static/manuals.install.html
If you are using docker you can check some Dockerfiles to create images in the docker directory.
Documentation
-------------
Read the full documentation at: http://bitcoinlib.readthedocs.io/
Example
-------
The bitcoin library contains a wallet implementation using SQLAlchemy and SQLite3 to import, create and manage
keys in a Hierarchical Deterministic way.
Example: Create wallet and generate new address (key) to receive bitcoins
.. code-block:: pycon
>>> from bitcoinlib.wallets import Wallet
>>> w = Wallet.create('Wallet1')
>>> w.get_key().address
'1Fo7STj6LdRhUuD1AiEsHpH65pXzraGJ9j'
Now send a small transaction to your wallet and use the scan() method to update transactions and UTXO's
.. code-block:: pycon
>>> w.scan()
>>> w.info() # Shows wallet information, keys, transactions and UTXO's
When your wallet received a payment and has unspent transaction outputs, you can send bitcoins easily.
If successful a transaction ID is returned
.. code-block:: pycon
>>> t = w.send_to('1PWXhWvUH3bcDWn6Fdq3xhMRPfxRXTjAi1', '0.001 BTC', offline=False)
'b7feea5e7c79d4f6f343b5ca28fa2a1fcacfe9a2b7f44f3d2fd8d6c2d82c4078'
>>> t.info # Shows transaction information and send results
More examples
-------------
Checkout the documentation page https://bitcoinlib.readthedocs.io/en/latest/ or take a look at some
more examples at https://github.com/1200wd/bitcoinlib/tree/master/examples
Contact
-------
If you have any questions, encounter a problem or want to share an idea, please use Github Discussions
https://github.com/1200wd/bitcoinlib/discussions
Implements the following Bitcoin Improvement Proposals
------------------------------------------------------
- Hierarchical Deterministic Wallets (BIP0032)
- Passphrase-protected private key (BIP0038)
- Mnemonic code for generating deterministic keys (BIP0039)
- Purpose Field for Deterministic Wallets (BIP0043)
- Multi-Account Hierarchy for Deterministic Wallets (BIP0044)
- Structure for Deterministic P2SH Multisignature Wallets (BIP0045)
- Bech32/base32 address format for native v0-16 witness outputs (BIP0173)
- Native and P2SH nested Segregated Witness transactions (BIP0141 and BIP0143)
- Bech32m format for v1+ witness addresses (BIP0350)
- and many more...
Future / Roadmap
----------------
- Support advanced scripts
- Fully support timelocks
- Support for lightning network
- Support for Trezor wallet or other hardware wallets
- Allow to scan full blockchain
- Integrate simple SPV client
- Support Schnorr signatures
Disclaimer
----------
This library is still in development, please use at your own risk and test sufficiently before using it in a
production environment.
Raw data
{
"_id": null,
"home_page": "http://github.com/1200wd/bitcoinlib",
"name": "bitcoinlib",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "bitcoin library cryptocurrency wallet crypto keys segwit transactions blocks",
"author": "1200wd",
"author_email": "info@1200wd.com",
"download_url": "https://files.pythonhosted.org/packages/9f/3d/0c82ca283371c0704f063fc0324c91f0b5137eb397e88957f9ea3b743586/bitcoinlib-0.6.14.tar.gz",
"platform": null,
"description": "Python Bitcoin Library\n======================\n\nBitcoin cryptocurrency Library writen in Python.\n\nAllows you to create a fully functional Bitcoin wallet with a single line of code.\nUse this library to create and manage transactions, addresses/keys, wallets, mnemonic password phrases and blocks with\nsimple and straightforward Python code.\n\nYou can use this library at a high level and create and manage wallets from the command line or at a low level\nand create your own custom made transactions, scripts, keys or wallets.\n\nThe BitcoinLib connects to various service providers automatically to update wallets, transaction and\nblockchain information.\n\n.. image:: https://github.com/1200wd/bitcoinlib/actions/workflows/unittests.yaml/badge.svg\n :target: https://github.com/1200wd/bitcoinlib/actions/workflows/unittests.yaml\n :alt: Unittests\n.. image:: https://img.shields.io/pypi/v/bitcoinlib.svg\n :target: https://pypi.org/pypi/bitcoinlib/\n :alt: PyPi\n.. image:: https://readthedocs.org/projects/bitcoinlib/badge/?version=latest\n :target: http://bitcoinlib.readthedocs.io/en/latest/?badge=latest\n :alt: RTD\n.. image:: https://coveralls.io/repos/github/1200wd/bitcoinlib/badge.svg?branch=installation-documentation-update\n :target: https://coveralls.io/github/1200wd/bitcoinlib?branch=master\n :alt: Coveralls\n\n\nInstall\n-------\n\nInstalled required packages\n\n.. code-block:: bash\n\n $ sudo apt install build-essential python3-dev libgmp3-dev\n\nThen install using pip\n\n.. code-block:: bash\n\n $ pip install bitcoinlib\n\nFor more detailed installation instructions, how to install on other systems or troubleshooting please read https://bitcoinlib.readthedocs.io/en/latest/source/_static/manuals.install.html\n\nIf you are using docker you can check some Dockerfiles to create images in the docker directory.\n\nDocumentation\n-------------\n\nRead the full documentation at: http://bitcoinlib.readthedocs.io/\n\n\nExample\n-------\n\nThe bitcoin library contains a wallet implementation using SQLAlchemy and SQLite3 to import, create and manage\nkeys in a Hierarchical Deterministic way.\n\nExample: Create wallet and generate new address (key) to receive bitcoins\n\n.. code-block:: pycon\n\n >>> from bitcoinlib.wallets import Wallet\n >>> w = Wallet.create('Wallet1')\n >>> w.get_key().address\n '1Fo7STj6LdRhUuD1AiEsHpH65pXzraGJ9j'\n\nNow send a small transaction to your wallet and use the scan() method to update transactions and UTXO's\n\n.. code-block:: pycon\n\n >>> w.scan()\n >>> w.info() # Shows wallet information, keys, transactions and UTXO's\n\nWhen your wallet received a payment and has unspent transaction outputs, you can send bitcoins easily.\nIf successful a transaction ID is returned\n\n.. code-block:: pycon\n\n >>> t = w.send_to('1PWXhWvUH3bcDWn6Fdq3xhMRPfxRXTjAi1', '0.001 BTC', offline=False)\n 'b7feea5e7c79d4f6f343b5ca28fa2a1fcacfe9a2b7f44f3d2fd8d6c2d82c4078'\n >>> t.info # Shows transaction information and send results\n\n\nMore examples\n-------------\n\nCheckout the documentation page https://bitcoinlib.readthedocs.io/en/latest/ or take a look at some\nmore examples at https://github.com/1200wd/bitcoinlib/tree/master/examples\n\n\nContact\n-------\n\nIf you have any questions, encounter a problem or want to share an idea, please use Github Discussions\nhttps://github.com/1200wd/bitcoinlib/discussions\n\n\nImplements the following Bitcoin Improvement Proposals\n------------------------------------------------------\n- Hierarchical Deterministic Wallets (BIP0032)\n- Passphrase-protected private key (BIP0038)\n- Mnemonic code for generating deterministic keys (BIP0039)\n- Purpose Field for Deterministic Wallets (BIP0043)\n- Multi-Account Hierarchy for Deterministic Wallets (BIP0044)\n- Structure for Deterministic P2SH Multisignature Wallets (BIP0045)\n- Bech32/base32 address format for native v0-16 witness outputs (BIP0173)\n- Native and P2SH nested Segregated Witness transactions (BIP0141 and BIP0143)\n- Bech32m format for v1+ witness addresses (BIP0350)\n- and many more...\n\n\nFuture / Roadmap\n----------------\n\n- Support advanced scripts\n- Fully support timelocks\n- Support for lightning network\n- Support for Trezor wallet or other hardware wallets\n- Allow to scan full blockchain\n- Integrate simple SPV client\n- Support Schnorr signatures\n\n\nDisclaimer\n----------\n\nThis library is still in development, please use at your own risk and test sufficiently before using it in a\nproduction environment.\n",
"bugtrack_url": null,
"license": "GNU3",
"summary": "Bitcoin cryptocurrency Library",
"version": "0.6.14",
"project_urls": {
"Homepage": "http://github.com/1200wd/bitcoinlib"
},
"split_keywords": [
"bitcoin",
"library",
"cryptocurrency",
"wallet",
"crypto",
"keys",
"segwit",
"transactions",
"blocks"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ca062fe2acc08c3733d7b9a6b00a5b8d841741c05034ce261f55fbbc9a32cd31",
"md5": "eb7fd48faeb9b2c7922d6f8d2ded36c6",
"sha256": "237420962c9a53957d04c950dee922f151e8654abbbb75345f264df9cd0ce9bd"
},
"downloads": -1,
"filename": "bitcoinlib-0.6.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb7fd48faeb9b2c7922d6f8d2ded36c6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4276571,
"upload_time": "2024-01-15T21:04:20",
"upload_time_iso_8601": "2024-01-15T21:04:20.489474Z",
"url": "https://files.pythonhosted.org/packages/ca/06/2fe2acc08c3733d7b9a6b00a5b8d841741c05034ce261f55fbbc9a32cd31/bitcoinlib-0.6.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9f3d0c82ca283371c0704f063fc0324c91f0b5137eb397e88957f9ea3b743586",
"md5": "f3ecf0d68eb21d01e04e10df24ec6f84",
"sha256": "004f9f8fb34fb74f01990f6fa49f8791b252a77fb3f0650a997a0e3dfc6b32d7"
},
"downloads": -1,
"filename": "bitcoinlib-0.6.14.tar.gz",
"has_sig": false,
"md5_digest": "f3ecf0d68eb21d01e04e10df24ec6f84",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4185266,
"upload_time": "2024-01-15T21:04:24",
"upload_time_iso_8601": "2024-01-15T21:04:24.791784Z",
"url": "https://files.pythonhosted.org/packages/9f/3d/0c82ca283371c0704f063fc0324c91f0b5137eb397e88957f9ea3b743586/bitcoinlib-0.6.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-15 21:04:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "1200wd",
"github_project": "bitcoinlib",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "bitcoinlib"
}