Metadata-Version: 2.1
Name: cosmpy
Version: 0.2.0
Summary: A library for interacting with the cosmos networks
Home-page: https://github.com/fetchai/cosmpy
Author: Fetch.AI Limited
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/fetchai/cosmpy/issues
Project-URL: Source, https://github.com/fetchai/cosmpy
Description: <h1 align="center">
            <b>CosmPy</b>
        </h1>
        
        <p align="center">
          <a href="https://pypi.org/project/cosmpy/">
            <img alt="PyPI" src="https://img.shields.io/pypi/v/cosmpy">
          </a>
          <a href="https://pypi.org/project/cosmpy/">
            <img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/cosmpy">
          </a>
          <a>
            <img alt="PyPI - Wheel" src="https://img.shields.io/pypi/wheel/cosmpy">
          </a>
          <a href="https://github.com/fetchai/cosmpy/blob/main/LICENSE">
            <img alt="License" src="https://img.shields.io/pypi/l/cosmpy"> 
          </a>
        </p>
        <p align="center">
          <a href="https://github.com/fetchai/cosmpy/actions/workflows/workflow.yml">
            <img alt="AEA framework sanity checks and tests" src="https://github.com/fetchai/cosmpy/actions/workflows/workflow.yml/badge.svg">
          </a>
        
        [comment]: <> (  <a href="">)
        [comment]: <> (    <img alt="Codecov" src="https://img.shields.io/codecov/c/github/fetchai/cosmpy">)
        [comment]: <> (  </a>)
        
          <a href="https://img.shields.io/badge/lint-flake8-blueviolet">
            <img alt="flake8" src="https://img.shields.io/badge/lint-flake8-yellow" >
          </a>
          <a href="https://github.com/python/mypy">
            <img alt="mypy" src="https://img.shields.io/badge/static%20check-mypy-blue">
          </a>
          <a href="https://github.com/psf/black">
            <img alt="Black" src="https://img.shields.io/badge/code%20style-black-black">
          </a>
          <a href="https://github.com/PyCQA/bandit">
            <img alt="mypy" src="https://img.shields.io/badge/security-bandit-lightgrey">
          </a>
        </p>
        
        <p align="center">
        A python library for interacting with cosmos based blockchain networks
        </p>
        
        ## Installing
        
        To install the project use:
        
            pip3 install cosmpy
        
        ## Getting started
        
        Below is a simple example for querying an account's balance and sending funds from one account to another using `RestClient`:
        
            from cosmpy.clients.signing_cosmwasm_client import SigningCosmWasmClient
            from cosmpy.common.rest_client import RestClient
            from cosmpy.crypto.address import Address
            from cosmpy.crypto.keypairs import PrivateKey
            from cosmpy.protos.cosmos.base.v1beta1.coin_pb2 import Coin
        
            # Data
            rest_endpoint_address = "http://the_rest_endpoint"
            alice_private_key = PrivateKey(bytes.fromhex("<private_key_in_hex_format>"))
            chain_id = "some_chain_id"
            denom = "some_denomination"
            bob_address = Address("some_address")
        
            channel = RestClient(rest_endpoint_address)
            client = SigningCosmWasmClient(private_key, channel, chain_id)
            
            # Query Alice's Balance
            res = client.get_balance(client.address, denom)
            print(f"Alice's Balance: {res.balance.amount} {res.balance.denom}")
            
            # Send 1 <denom> from Alice to Bob
            client.send_tokens(bob_address, [Coin(amount="1", denom=denom)])
        
        ## Documentation
        
        To see the documentation, first run:
        
        ```bash
        make generate-docs
        ```
        
        Then (if on Linux or MacOS):
        
        ```bash
        make open-docs
        ```
        
        And if on windows, open `docs/build/html/index.html`.
        
        ## Examples
        
        Under the `examples` directory, you can find examples of basic ledger interactions with `cosmpy` using both REST and gRPC, e.g. querying, sending a transaction, interacting with a smart contract, and performing atomic swaps. To run any example `<example_file_name>`:  
        
          ```bash
          python ./examples/<example_file_name>.py
          ```
        
        ## Extra Resources
        
        * [Github Repo](https://github.com/fetchai/cosmpy)
        * [Bug Reports](https://github.com/fetchai/cosmpy/issues)
        * [Discussions](https://github.com/fetchai/cosmpy/discussions)
        
Keywords: cosmos,gaia,fetchhub,fetchai
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
