{"id":19724757,"url":"https://github.com/bigchaindb/bigchaindb-driver","last_synced_at":"2025-04-05T17:02:56.347Z","repository":{"id":10377148,"uuid":"65545148","full_name":"bigchaindb/bigchaindb-driver","owner":"bigchaindb","description":"Official Python driver for BigchainDB","archived":false,"fork":false,"pushed_at":"2022-12-26T20:28:20.000Z","size":1008,"stargazers_count":106,"open_issues_count":20,"forks_count":104,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-03-29T16:02:53.794Z","etag":null,"topics":["bigchaindb","bigchaindb-driver","python"],"latest_commit_sha":null,"homepage":"https://www.bigchaindb.com","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bigchaindb.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-08-12T10:27:39.000Z","updated_at":"2025-03-22T02:44:04.000Z","dependencies_parsed_at":"2023-01-13T15:54:29.046Z","dependency_job_id":null,"html_url":"https://github.com/bigchaindb/bigchaindb-driver","commit_stats":null,"previous_names":[],"tags_count":25,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigchaindb%2Fbigchaindb-driver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigchaindb%2Fbigchaindb-driver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigchaindb%2Fbigchaindb-driver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bigchaindb%2Fbigchaindb-driver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bigchaindb","download_url":"https://codeload.github.com/bigchaindb/bigchaindb-driver/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247369950,"owners_count":20927928,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bigchaindb","bigchaindb-driver","python"],"created_at":"2024-11-11T23:26:56.275Z","updated_at":"2025-04-05T17:02:56.320Z","avatar_url":"https://github.com/bigchaindb.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n.. Copyright BigchainDB GmbH and BigchainDB contributors\n   SPDX-License-Identifier: (Apache-2.0 AND CC-BY-4.0)\n   Code is Apache-2.0 and docs are CC-BY-4.0\n\n.. image:: media/repo-banner@2x.png\n\n.. image:: https://badges.gitter.im/bigchaindb/bigchaindb-driver.svg\n   :alt: Join the chat at https://gitter.im/bigchaindb/bigchaindb-driver\n   :target: https://gitter.im/bigchaindb/bigchaindb-driver?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge\n\n\n.. image:: https://img.shields.io/pypi/v/bigchaindb-driver.svg\n        :target: https://pypi.python.org/pypi/bigchaindb-driver\n\n.. image:: https://img.shields.io/travis/bigchaindb/bigchaindb-driver/master.svg\n        :target: https://travis-ci.com/bigchaindb/bigchaindb-driver\n\n.. image:: https://img.shields.io/codecov/c/github/bigchaindb/bigchaindb-driver/master.svg\n    :target: https://codecov.io/github/bigchaindb/bigchaindb-driver?branch=master\n\n.. image:: https://readthedocs.org/projects/bigchaindb-python-driver/badge/?version=latest\n        :target: http://bigchaindb.readthedocs.io/projects/py-driver/en/latest/?badge=latest\n        :alt: Documentation Status\n\nBigchainDB Python Driver\n==========================\n\n* Free software: Apache Software License 2.0\n* Check our `Documentation`_\n\n.. contents:: Table of Contents\n\n\nFeatures\n--------\n\n* Support for preparing, fulfilling, and sending transactions to a BigchainDB\n  node.\n* Retrieval of transactions by id.\n\nInstall\n----------\n\nThe instructions below were tested on Ubuntu 16.04 LTS. They should also work on other Linux distributions and on macOS. The driver might work on Windows as well, but we do not guarantee it. We recommend to set up (e.g. via Docker on Windows) an Ubuntu VM there.\n\nWe recommend you use a virtual environment to install and update to the latest stable version using `pip` (or `pip3`):\n\n.. code-block:: text\n\n    pip install -U bigchaindb-driver\n\nThat will install the latest *stable* BigchainDB Python Driver. If you want to install an Alpha, Beta or RC version of the Python Driver, use something like:\n\n.. code-block:: text\n\n    pip install -U bigchaindb_driver==0.5.0a4\n\nThe above command will install version 0.5.0a4 (Alpha 4). You can find a list of all versions in `the release history page on PyPI \u003chttps://pypi.org/project/bigchaindb-driver/#history\u003e`_.\n\nMore information on how to install the driver can be found in the `Quickstart`_\n\nBigchainDB Documentation\n------------------------------------\n* `BigchainDB Server Quickstart`_\n* `The Hitchhiker's Guide to BigchainDB`_\n* `HTTP API Reference`_\n* `All BigchainDB Documentation`_\n\nUsage\n----------\nExample: Create a divisible asset for Alice who issues 10 token to Bob so that he can use her Game Boy.\nAfterwards Bob spends 3 of these tokens.\n\nIf you want to send a transaction you need to `Determine the BigchainDB Root URL`_.\n\n.. code-block:: python\n\n    # import BigchainDB and create an object\n    from bigchaindb_driver import BigchainDB\n    bdb_root_url = 'https://example.com:9984'\n    bdb = BigchainDB(bdb_root_url)\n\n    # generate a keypair\n    from bigchaindb_driver.crypto import generate_keypair\n    alice, bob = generate_keypair(), generate_keypair()\n\n    # create a digital asset for Alice\n    game_boy_token = {\n        'data': {\n            'token_for': {\n                'game_boy': {\n                    'serial_number': 'LR35902'\n                }\n            },\n            'description': 'Time share token. Each token equals one hour of usage.',\n        },\n    }\n\n    # prepare the transaction with the digital asset and issue 10 tokens for Bob\n    prepared_token_tx = bdb.transactions.prepare(\n        operation='CREATE',\n        signers=alice.public_key,\n        recipients=[([bob.public_key], 10)],\n        asset=game_boy_token)\n\n    # fulfill and send the transaction\n    fulfilled_token_tx = bdb.transactions.fulfill(\n        prepared_token_tx,\n        private_keys=alice.private_key)\n    bdb.transactions.send_commit(fulfilled_token_tx)\n\n    # Use the tokens\n    # create the output and inout for the transaction\n    transfer_asset = {'id': fulfilled_token_tx['id']}\n    output_index = 0\n    output = fulfilled_token_tx['outputs'][output_index]\n    transfer_input = {'fulfillment': output['condition']['details'],\n                      'fulfills': {'output_index': output_index,\n                                   'transaction_id': transfer_asset['id']},\n                      'owners_before': output['public_keys']}\n\n    # prepare the transaction and use 3 tokens\n    prepared_transfer_tx = bdb.transactions.prepare(\n        operation='TRANSFER',\n        asset=transfer_asset,\n        inputs=transfer_input,\n        recipients=[([alice.public_key], 3), ([bob.public_key], 7)])\n\n    # fulfill and send the transaction\n    fulfilled_transfer_tx = bdb.transactions.fulfill(\n        prepared_transfer_tx,\n        private_keys=bob.private_key)\n    sent_transfer_tx = bdb.transactions.send_commit(fulfilled_transfer_tx)\n\nCompatibility Matrix\n--------------------\n\n+-----------------------+---------------------------+\n| **BigchainDB Server** | **BigchainDB Driver**     |\n+=======================+===========================+\n| ``\u003e= 2.0.0b7``        | ``0.6.2``                 |\n+-----------------------+---------------------------+\n| ``\u003e= 2.0.0b7``        | ``0.6.1``                 |\n+-----------------------+---------------------------+\n| ``\u003e= 2.0.0b7``        | ``0.6.0``                 |\n+-----------------------+---------------------------+\n| ``\u003e= 2.0.0b5``        | ``0.5.3``                 |\n+-----------------------+---------------------------+\n| ``\u003e= 2.0.0b5``        | ``0.5.2``                 |\n+-----------------------+---------------------------+\n| ``\u003e= 2.0.0b5``        | ``0.5.1``                 |\n+-----------------------+---------------------------+\n| ``\u003e= 2.0.0b1``        | ``0.5.0``                 |\n+-----------------------+---------------------------+\n| ``\u003e= 2.0.0a3``        | ``0.5.0a4``               |\n+-----------------------+---------------------------+\n| ``\u003e= 2.0.0a2``        | ``0.5.0a2``               |\n+-----------------------+---------------------------+\n| ``\u003e= 2.0.0a1``        | ``0.5.0a1``               |\n+-----------------------+---------------------------+\n| ``\u003e= 1.0.0``          | ``0.4.x``                 |\n+-----------------------+---------------------------+\n| ``== 1.0.0rc1``       | ``0.3.x``                 |\n+-----------------------+---------------------------+\n| ``\u003e= 0.9.1``          | ``0.2.x``                 |\n+-----------------------+---------------------------+\n| ``\u003e= 0.8.2``          | ``\u003e= 0.1.3``              |\n+-----------------------+---------------------------+\n\n`Although we do our best to keep the master branches in sync, there may be\noccasional delays.`\n\nLicense\n--------\n* `licenses`_ - open source \u0026 open content\n\nCredits\n-------\n\nThis package was initially created using Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. Many BigchainDB developers have contributed since then.\n\n.. _Documentation: https://docs.bigchaindb.com/projects/py-driver/\n.. _pypi history: https://pypi.org/project/bigchaindb-driver/#history\n.. _Quickstart: https://docs.bigchaindb.com/projects/py-driver/en/latest/quickstart.html\n.. _BigchainDB Server Quickstart: https://docs.bigchaindb.com/projects/server/en/latest/quickstart.html\n.. _The Hitchhiker's Guide to BigchainDB: https://www.bigchaindb.com/developers/guide/\n.. _HTTP API Reference: https://docs.bigchaindb.com/projects/server/en/latest/http-client-server-api.html\n.. _All BigchainDB Documentation: https://docs.bigchaindb.com/\n.. _Determine the BigchainDB Root URL: https://docs.bigchaindb.com/projects/py-driver/en/latest/connect.html\n.. _licenses: https://github.com/bigchaindb/bigchaindb-driver/blob/master/LICENSES.md\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigchaindb%2Fbigchaindb-driver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbigchaindb%2Fbigchaindb-driver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbigchaindb%2Fbigchaindb-driver/lists"}