dazl


Namedazl JSON
Version 8.4.2 PyPI version JSON
download
home_pagehttps://github.com/digital-asset/dazl-client
Summaryhigh-level Ledger API client for Daml ledgers
upload_time2025-07-28 21:33:25
maintainerNone
docs_urlNone
authorDavin K. Tanabe
requires_python<4.0.0,>=3.10.0
licenseApache-2.0
keywords daml blockchain dlt distributed ledger digital asset
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            Daml Python bindings (formerly known as dazl)
=============================================

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/digital-asset/dazl-client/blob/main/LICENSE)
<a href="https://circleci.com/gh/digital-asset/dazl-client">
<img src="https://circleci.com/gh/digital-asset/dazl-client.svg?style=svg">
</a>

Copyright (c) 2017-2025 Digital Asset (Switzerland) GmbH and/or its affiliates. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0


Rich Python bindings for accessing Ledger API-based applications.

Documentation
-------------
The user documentation is available online [here](https://digital-asset.github.io/dazl-client).

Installation
------------
If you just want to use the library, you can install it locally with `pip`:
```sh
pip install --user dazl
```

Requirements
------------
* Python 3.10+
* Go 1.23
* [Daml SDK](https://www.daml.com)
    * Daml 2: 2.10 or later

Examples
--------

All of the examples below assume you imported `dazl`, and are running a ledger with the default scenario generated with `daml new`.

Connect to the ledger and submit a single command:

```py
import asyncio
import dazl

async def main():
    async with dazl.connect(url='http://localhost:6865', act_as='Alice') as client:
        contract = { 'issuer' : 'Alice', 'owner' : 'Alice', 'name' : 'hello world!' }
        await client.create('Main:Asset', contract)

asyncio.run(main())
```

Connect to the ledger as a single party, print all contracts, and close:

```py
import asyncio
import dazl
from dazl.ledgerutil import ACS

async def main():
    async with dazl.connect(url='http://localhost:6865', read_as='Alice') as conn:
        async with ACS(conn, {"*": {}}) as acs:
            snapshot = await acs.read()

    print(snapshot)

asyncio.run(main())
```

Building locally
----------------

You will need additional dependencies to build locally:

* Direnv (https://direnv.net/)
* Nix (https://nixos.org/download/)

Once you have these prerequisites in place:

```sh
make build
```

Tests
-----

Tests in the Daml Python bindings are written using [pytest](https://docs.pytest.org/en/latest/). You can run them by doing:

```sh
make test
```

Support
-------

The Daml Python bindings library are supported under the Daml Enterprise license. If you do not have a Daml Enterprise license and are in need of support, have questions or just want to engage in friendly conversation anything Daml, contact us on our [Daml Community Forum](https://discuss.daml.com).

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/digital-asset/dazl-client",
    "name": "dazl",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0.0,>=3.10.0",
    "maintainer_email": null,
    "keywords": "daml, blockchain, dlt, distributed ledger, digital asset",
    "author": "Davin K. Tanabe",
    "author_email": "davin.tanabe@digitalasset.com",
    "download_url": "https://files.pythonhosted.org/packages/61/59/a799a9cac458d5e64349ac86a272bd5d58e9f26f23a09766c775a4730ff7/dazl-8.4.2.tar.gz",
    "platform": null,
    "description": "Daml Python bindings (formerly known as dazl)\n=============================================\n\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/digital-asset/dazl-client/blob/main/LICENSE)\n<a href=\"https://circleci.com/gh/digital-asset/dazl-client\">\n<img src=\"https://circleci.com/gh/digital-asset/dazl-client.svg?style=svg\">\n</a>\n\nCopyright (c) 2017-2025 Digital Asset (Switzerland) GmbH and/or its affiliates. All Rights Reserved.\nSPDX-License-Identifier: Apache-2.0\n\n\nRich Python bindings for accessing Ledger API-based applications.\n\nDocumentation\n-------------\nThe user documentation is available online [here](https://digital-asset.github.io/dazl-client).\n\nInstallation\n------------\nIf you just want to use the library, you can install it locally with `pip`:\n```sh\npip install --user dazl\n```\n\nRequirements\n------------\n* Python 3.10+\n* Go 1.23\n* [Daml SDK](https://www.daml.com)\n    * Daml 2: 2.10 or later\n\nExamples\n--------\n\nAll of the examples below assume you imported `dazl`, and are running a ledger with the default scenario generated with `daml new`.\n\nConnect to the ledger and submit a single command:\n\n```py\nimport asyncio\nimport dazl\n\nasync def main():\n    async with dazl.connect(url='http://localhost:6865', act_as='Alice') as client:\n        contract = { 'issuer' : 'Alice', 'owner' : 'Alice', 'name' : 'hello world!' }\n        await client.create('Main:Asset', contract)\n\nasyncio.run(main())\n```\n\nConnect to the ledger as a single party, print all contracts, and close:\n\n```py\nimport asyncio\nimport dazl\nfrom dazl.ledgerutil import ACS\n\nasync def main():\n    async with dazl.connect(url='http://localhost:6865', read_as='Alice') as conn:\n        async with ACS(conn, {\"*\": {}}) as acs:\n            snapshot = await acs.read()\n\n    print(snapshot)\n\nasyncio.run(main())\n```\n\nBuilding locally\n----------------\n\nYou will need additional dependencies to build locally:\n\n* Direnv (https://direnv.net/)\n* Nix (https://nixos.org/download/)\n\nOnce you have these prerequisites in place:\n\n```sh\nmake build\n```\n\nTests\n-----\n\nTests in the Daml Python bindings are written using [pytest](https://docs.pytest.org/en/latest/). You can run them by doing:\n\n```sh\nmake test\n```\n\nSupport\n-------\n\nThe Daml Python bindings library are supported under the Daml Enterprise license. If you do not have a Daml Enterprise license and are in need of support, have questions or just want to engage in friendly conversation anything Daml, contact us on our [Daml Community Forum](https://discuss.daml.com).\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "high-level Ledger API client for Daml ledgers",
    "version": "8.4.2",
    "project_urls": {
        "Homepage": "https://github.com/digital-asset/dazl-client",
        "Repository": "https://github.com/digital-asset/dazl-client"
    },
    "split_keywords": [
        "daml",
        " blockchain",
        " dlt",
        " distributed ledger",
        " digital asset"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "38a95fc541d3a943f79d72cdb18c1e011dd3dc66feee700e6c25af2b13919d38",
                "md5": "b8bd2ffaf5ee367e0b9025b19c25d333",
                "sha256": "8aa4db5bd6df6c63f2644071e2861afcfe14ceeda5bc0cc66e360b36ad38ead3"
            },
            "downloads": -1,
            "filename": "dazl-8.4.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "b8bd2ffaf5ee367e0b9025b19c25d333",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0.0,>=3.10.0",
            "size": 1268496,
            "upload_time": "2025-07-28T21:33:23",
            "upload_time_iso_8601": "2025-07-28T21:33:23.571183Z",
            "url": "https://files.pythonhosted.org/packages/38/a9/5fc541d3a943f79d72cdb18c1e011dd3dc66feee700e6c25af2b13919d38/dazl-8.4.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6159a799a9cac458d5e64349ac86a272bd5d58e9f26f23a09766c775a4730ff7",
                "md5": "649c53bdf3f9247b1ec03de7930443c7",
                "sha256": "111ef5b44aabb02b70effd3e44a8cdf97b7b6c0c30ee87bf34598e586bb13732"
            },
            "downloads": -1,
            "filename": "dazl-8.4.2.tar.gz",
            "has_sig": false,
            "md5_digest": "649c53bdf3f9247b1ec03de7930443c7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0.0,>=3.10.0",
            "size": 641031,
            "upload_time": "2025-07-28T21:33:25",
            "upload_time_iso_8601": "2025-07-28T21:33:25.305288Z",
            "url": "https://files.pythonhosted.org/packages/61/59/a799a9cac458d5e64349ac86a272bd5d58e9f26f23a09766c775a4730ff7/dazl-8.4.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-28 21:33:25",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "digital-asset",
    "github_project": "dazl-client",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "circle": true,
    "lcname": "dazl"
}
        
Elapsed time: 0.93622s