Metadata-Version: 2.1
Name: diem
Version: 1.6.0
Summary: The Python Client SDK for Diem
Home-page: https://github.com/diem/client-sdk-python
Author: The Diem Core Contributors
Author-email: developers@diem.com
License: Apache-2.0
Description: # The official Diem Client SDK for Python.
        
        [![pypi](https://img.shields.io/pypi/v/diem)](https://pypi.org/project/diem/)
        ![Apache V2 License](https://img.shields.io/pypi/l/diem)
        ![Python versoins](https://img.shields.io/pypi/pyversions/diem)
        
        [API Reference](https://diem.github.io/client-sdk-python/diem)
        
        ## Pypi package
        
        https://pypi.org/project/diem/
        
        ## Examples
        
        ```python3
        
        >>> from diem import jsonrpc, testnet
        >>> client = jsonrpc.Client(testnet.JSON_RPC_URL)
        >>> client.get_metadata()
        version: 3300304
        timestamp: 1601492912847973
        chain_id: 2
        
        ```
        
        You can find more examples under the [`examples`](./examples/) directory:
        
        * [Create Child VASP account](./examples/create_child_vasp.py)
        * [All Types Peer To Peer Transfer](./examples/p2p_transfer.py)
        * [Intent Identifier](./examples/intent_identifier.py)
        
        Note: `make test` runs all examples too, see the Makefile for details.
        
        ### Off-chain service example
        
        Checkout [MiniWallet](./src/diem/testing/miniwallet/app) implementation for off-chain service implementation example.
        
        ## MiniWallet and MiniWallet Test Suite
        
        See [mini_wallet.md](mini-wallet.md)
        
        
        ## Build & Test
        
        ```
        make init
        make test
        ```
        
        run specific test:
        
        ```
        make test t=<test file / test name match pattern>
        ```
        
        run with local docker testnet (requires initializing diem submodule):
        
        ```
        make test t=<test file / test name match pattern> dt=1
        ```
        
        ## Re-generate diem_types, stdlib, jsonrpc response data structures
        
        ```
        git submodule update --init diem
        cd diem
        git pull origin master
        cd ..
        make gen
        ```
        
        ## Modules Overview
        
        > SPEC = specification
        
        > DIP-X = Diem Improvement Protocol
        
        Root module name: `diem`
        
        Sub-modules:
        
        - `jsonrpc`: diem JSON-RPC APIs client and API response types. [SPEC](https://github.com/diem/diem/blob/master/json-rpc/json-rpc-spec.md)
        - `stdlib`: generated code, move stdlib script utils for constructing transaction script playload.
        - `diem_types`: generated code, Diem on-chain data structure types for encoding and decoding [BCS](https://crates.io/crates/bcs) data.
        - `utils`: utility functions, account address utils, currency code, hashing, hex encoding / decoding, transaction utils.
        - `AuthKey` | `auth_key`: auth key utils
        - `identifier`: Diem Account Identifier and Diem Intent Identifier. [DIP-5](https://dip.diem.com/dip-5/)
        - `txnmetadata`: utils for creating peer to peer transaction metadata. [DIP-4](https://dip.diem.com/dip-4/)
        - `testnet`: Testnet utility, minting coins, create Testnet client, chain id, Testnet JSON-RPC URL.
        - `testing`: Testing utility, MiniWallet application, MiniWallet test suites, `LocalAccount` for managing local account keys and generating random local account.
        - `chain_ids`: list of static chain ids
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: all
