<h1 align="center">
<b>KiiPy</b>
</h1>
<p align="center">
A python library for interacting with KiiChain and other Cosmos-based blockchain networks
</p>
[comment]: # (TODO: Add proper badges here)
<p align="center">
<!-- <a href="https://pypi.org/project/kiipy/">
<img alt="PyPI" src="https://img.shields.io/pypi/v/kiipy">
</a>
<a href="https://pypi.org/project/kiipy/">
<img alt="PyPI - Python Version" src="https://img.shields.io/pypi/pyversions/kiipy">
</a>
<a href="https://github.com/KiiBlockchain/kiipy/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/pypi/l/kiipy">
</a>
<br />
<a>
<img alt="PyPI - Wheel" src="https://img.shields.io/pypi/wheel/kiipy">
</a> -->
<a href="https://github.com/KiiBlockchain/kiipy/actions/workflows/workflow.yml">
<img alt="Sanity checks and tests" src="https://github.com/KiiBlockchain/kiipy/actions/workflows/workflow.yml/badge.svg">
</a>
<!-- <a href="https://pypi.org/project/kiipy/">
<img alt="Download per Month" src="https://img.shields.io/pypi/dm/kiipy">
</a> -->
</p>
*This project has been forked from [Fetch AI's CosmPy](https://github.com/fetchai/cosmpy).*
## DEVELOPMENT NOTES
**This project is still under development.**
Details on how to setup the dev environment can be found in the [development guidelines][developing]. Using poetry virtual environment is highly encouraged to ensure seamless development.
Notes:
- Items that need to be looked into are marked as `TODO:` in the code and docs.
- Workflows are failing due to usage limits. It's advisable to fix this to ensure code quality. Current workaround is to make sure to run corresponding checks and tests locally.
## Installation
### Install with pip
```bash
pip install kiipy
```
### Install from source code
1. Clone the repository
```
git clone https://github.com/KiiBlockchain/kiipy.git
cd kiipy
```
2. Install the required dependencies
```
poetry install
```
3. Open the virtual environment
```
poetry shell
```
## Getting Started
Below is a simple example for querying an account's balances:
```python
from kiipy.aerial.client import LedgerClient, NetworkConfig
# connect to Kii test network using default parameters
ledger_client = LedgerClient(NetworkConfig.kii_testnet())
alice: str = 'kii1pyt53arxkg5t4aww892esskltrf54mg88va98y'
balances = ledger_client.query_bank_all_balances(alice)
# show all coin balances
for coin in balances:
print(f'{coin.amount}{coin.denom}')
```
## Documentation
[comment]: # (TODO: Update this and other occurence with proper docs url)
The full documentation can be found [here](https://docs.kiiglobal.io/kiipy/).
## Examples
Under the `examples` directory, you can find examples of basic ledger interactions using `kiipy`, such as transferring tokens, staking, and deploying.
## Contributing
All contributions are very welcome! Remember, contribution is not only PRs and code, but any help with docs or helping other developers solve their issues are very appreciated!
Read below to learn how you can take part in the KiiPy project.
### Code of Conduct
Please be sure to read and follow our [Code of Conduct][coc]. By participating, you are expected to uphold this code.
### Contribution Guidelines
Read our [contribution guidelines][contributing] to learn about our issue and pull request submission processes, coding rules, and more.
### Development Guidelines
Read our [development guidelines][developing] to learn about the development processes and workflows.
### Issues, Questions and Discussions
We use [GitHub Issues][issues] for tracking requests and bugs, and [GitHub Discussions][discussion] for general questions and discussion.
## License
The KiiPy project is licensed under [Apache License 2.0][license].
[contributing]: https://github.com/KiiBlockchain/kiipy/blob/main/CONTRIBUTING.md
[developing]: https://github.com/KiiBlockchain/kiipy/blob/main/DEVELOPING.md
[coc]: https://github.com/KiiBlockchain/kiipy/blob/main/CODE_OF_CONDUCT.md
[discussion]: https://github.com/KiiBlockchain/kiipy/discussions
[issues]: https://github.com/KiiBlockchain/kiipy/issues
[license]: https://github.com/KiiBlockchain/kiipy/blob/main/LICENSE
Raw data
{
"_id": null,
"home_page": "https://github.com/KiiBlockchain/kiipy",
"name": "kiipy",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "KiiPy, Cosmos-SDK",
"author": "Kii Global",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/95/8f/5852941d8ed720bf9953448736194b1d701f3f9be2755511dbb2cca4ee32/kiipy-0.1.0.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n <b>KiiPy</b>\n</h1>\n\n<p align=\"center\">\nA python library for interacting with KiiChain and other Cosmos-based blockchain networks\n</p>\n\n[comment]: # (TODO: Add proper badges here)\n\n<p align=\"center\">\n <!-- <a href=\"https://pypi.org/project/kiipy/\">\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/kiipy\">\n </a>\n <a href=\"https://pypi.org/project/kiipy/\">\n <img alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/kiipy\">\n </a>\n <a href=\"https://github.com/KiiBlockchain/kiipy/blob/main/LICENSE\">\n <img alt=\"License\" src=\"https://img.shields.io/pypi/l/kiipy\">\n </a>\n <br />\n <a>\n <img alt=\"PyPI - Wheel\" src=\"https://img.shields.io/pypi/wheel/kiipy\">\n </a> -->\n <a href=\"https://github.com/KiiBlockchain/kiipy/actions/workflows/workflow.yml\">\n <img alt=\"Sanity checks and tests\" src=\"https://github.com/KiiBlockchain/kiipy/actions/workflows/workflow.yml/badge.svg\">\n </a>\n <!-- <a href=\"https://pypi.org/project/kiipy/\">\n <img alt=\"Download per Month\" src=\"https://img.shields.io/pypi/dm/kiipy\">\n </a> -->\n</p>\n\n*This project has been forked from [Fetch AI's CosmPy](https://github.com/fetchai/cosmpy).*\n\n## DEVELOPMENT NOTES\n\n**This project is still under development.**\n\nDetails on how to setup the dev environment can be found in the [development guidelines][developing]. Using poetry virtual environment is highly encouraged to ensure seamless development.\n\nNotes:\n- Items that need to be looked into are marked as `TODO:` in the code and docs.\n- Workflows are failing due to usage limits. It's advisable to fix this to ensure code quality. Current workaround is to make sure to run corresponding checks and tests locally.\n\n\n## Installation\n\n### Install with pip\n\n```bash\npip install kiipy\n```\n\n### Install from source code\n\n1. Clone the repository\n```\ngit clone https://github.com/KiiBlockchain/kiipy.git\ncd kiipy\n```\n\n2. Install the required dependencies\n```\npoetry install\n```\n\n3. Open the virtual environment\n```\npoetry shell\n```\n\n## Getting Started\n\nBelow is a simple example for querying an account's balances:\n\n```python\nfrom kiipy.aerial.client import LedgerClient, NetworkConfig\n\n# connect to Kii test network using default parameters\nledger_client = LedgerClient(NetworkConfig.kii_testnet())\n\nalice: str = 'kii1pyt53arxkg5t4aww892esskltrf54mg88va98y'\nbalances = ledger_client.query_bank_all_balances(alice)\n\n# show all coin balances\nfor coin in balances:\n print(f'{coin.amount}{coin.denom}')\n```\n\n## Documentation\n\n[comment]: # (TODO: Update this and other occurence with proper docs url)\nThe full documentation can be found [here](https://docs.kiiglobal.io/kiipy/).\n\n## Examples\n\nUnder the `examples` directory, you can find examples of basic ledger interactions using `kiipy`, such as transferring tokens, staking, and deploying.\n\n## Contributing\n\nAll contributions are very welcome! Remember, contribution is not only PRs and code, but any help with docs or helping other developers solve their issues are very appreciated!\n\nRead below to learn how you can take part in the KiiPy project.\n\n### Code of Conduct\n\nPlease be sure to read and follow our [Code of Conduct][coc]. By participating, you are expected to uphold this code.\n\n### Contribution Guidelines\n\nRead our [contribution guidelines][contributing] to learn about our issue and pull request submission processes, coding rules, and more.\n\n### Development Guidelines\n\nRead our [development guidelines][developing] to learn about the development processes and workflows.\n\n### Issues, Questions and Discussions\n\nWe use [GitHub Issues][issues] for tracking requests and bugs, and [GitHub Discussions][discussion] for general questions and discussion.\n\n## License\n\nThe KiiPy project is licensed under [Apache License 2.0][license].\n\n[contributing]: https://github.com/KiiBlockchain/kiipy/blob/main/CONTRIBUTING.md\n[developing]: https://github.com/KiiBlockchain/kiipy/blob/main/DEVELOPING.md\n[coc]: https://github.com/KiiBlockchain/kiipy/blob/main/CODE_OF_CONDUCT.md\n[discussion]: https://github.com/KiiBlockchain/kiipy/discussions\n[issues]: https://github.com/KiiBlockchain/kiipy/issues\n[license]: https://github.com/KiiBlockchain/kiipy/blob/main/LICENSE\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "A Python SDK for Kii",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/KiiBlockchain/kiipy",
"Repository": "https://github.com/KiiBlockchain/kiipy"
},
"split_keywords": [
"kiipy",
" cosmos-sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dacf3a06fde76ba2d87789eab35e67b78b77ffbc2c067b34aab5d4374fc8b2b2",
"md5": "7f27b711c6007f18f19fbc458c827e5e",
"sha256": "69885677c317faaa20eac08d509f68f03e6ad686a9511e2c8e88a9ffe02d2c31"
},
"downloads": -1,
"filename": "kiipy-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7f27b711c6007f18f19fbc458c827e5e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 547798,
"upload_time": "2024-08-12T21:39:38",
"upload_time_iso_8601": "2024-08-12T21:39:38.984746Z",
"url": "https://files.pythonhosted.org/packages/da/cf/3a06fde76ba2d87789eab35e67b78b77ffbc2c067b34aab5d4374fc8b2b2/kiipy-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "958f5852941d8ed720bf9953448736194b1d701f3f9be2755511dbb2cca4ee32",
"md5": "2054ee369b13f135daee974d2e5df673",
"sha256": "746543364cd9cf642e4d98f4d67a56f2b06be6f4b10d07effe7fb6897adb73eb"
},
"downloads": -1,
"filename": "kiipy-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "2054ee369b13f135daee974d2e5df673",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 249970,
"upload_time": "2024-08-12T21:39:41",
"upload_time_iso_8601": "2024-08-12T21:39:41.235550Z",
"url": "https://files.pythonhosted.org/packages/95/8f/5852941d8ed720bf9953448736194b1d701f3f9be2755511dbb2cca4ee32/kiipy-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-12 21:39:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "KiiBlockchain",
"github_project": "kiipy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "kiipy"
}
JSON
