From 25827f70130eb065232b51d4e4a927dc890ffba4 Mon Sep 17 00:00:00 2001 From: nessshon Date: Tue, 9 Jan 2024 15:18:09 +0500 Subject: [PATCH] Update README.md. --- README.md | 98 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 64 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index 1c3814e..b370810 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,17 @@ # PyTONAPI -[![PyPI](https://img.shields.io/pypi/v/pytonapi.svg)](https://pypi.python.org/pypi/pytonapi) -![Python Versions](https://img.shields.io/pypi/pyversions/pytonapi.svg) -![License](https://img.shields.io/github/license/nessshon/pytonapi) +[![TON](https://img.shields.io/badge/TON-grey?logo=TON&logoColor=40AEF0)](https://ton.org) +[![PyPI](https://img.shields.io/pypi/v/pytonapi.svg?color=FFE873&labelColor=3776AB)](https://pypi.python.org/pypi/pytonapi) +![Python Versions](https://img.shields.io/pypi/pyversions/pytonapi.svg?color=FFE873&labelColor=3776AB) +[![License](https://img.shields.io/github/license/tonkeeper/pytonapi)](https://github.com/tonkeeper/pytonapi/blob/main/LICENSE) -Python wrapper for [tonapi.io](https://tonapi.io/api-v2)\ -**Note:** You need an API key to use it, get it here [tonconsole.com](https://tonconsole.com/) +![Downloads](https://pepy.tech/badge/pytonapi) +![Downloads](https://pepy.tech/badge/pytonapi/month) +![Downloads](https://pepy.tech/badge/pytonapi/week) + +Python SDK for [tonapi.io](https://tonapi.io).\ +Information about the API can be found in the [documentation](https://docs.tonconsole.com/tonapi/api-v2).\ +To use the API **you need an API key**, you can get it here [tonconsole.com](https://tonconsole.com/). ## Features @@ -22,40 +28,43 @@ Python wrapper for [tonapi.io](https://tonapi.io/api-v2)\ to nanotons or amounts. - **Extensive Examples:**\ - Explore a variety of examples in the [examples](examples) folder to help you get started and + Explore a variety of examples in the [examples](https://github.com/tonkeeper/pytonapi/tree/main/examples) folder to + help you get started and understand different use cases. ## Dependencies * [httpx](https://pypi.org/project/httpx/) - A fully featured HTTP client for Python 3, which provides sync and async * [pydantic](https://pypi.org/project/pydantic/) - Data validation and settings management using Python type hints -* [libscrc](https://pypi.org/project/libscrc/) - Library for calculating CRC-16, CRC-CCITT, CRC-32 checksums - APIs * [websockets](https://pypi.org/project/websockets/) - A library for building WebSocket servers and clients in Python -## Installation +## Usage + +### Installation ```bash pip install pytonapi ``` -## Usage +### Examples -**Synchronous Example:** +
+Asynchronous ```python -from pytonapi import Tonapi +from pytonapi import AsyncTonapi -def main(): +# Declare an asynchronous function for using await +async def main(): # Create a new Tonapi object with the provided API key - tonapi = Tonapi(api_key="Your API key") + tonapi = AsyncTonapi(api_key="Your API key") # Specify the account ID account_id = "EQC-3ilVr-W0Uc3pLrGJElwSaFxvhXXfkiQA3EwdVBHNNess" # noqa - # Retrieve account information - account = tonapi.accounts.get_info(account_id=account_id) + # Retrieve account information asynchronously + account = await tonapi.accounts.get_info(account_id=account_id) # Print account details print(f"Account Address (raw): {account.address.to_raw()}") @@ -65,26 +74,31 @@ def main(): if __name__ == '__main__': - main() + import asyncio + + # Run the asynchronous function + asyncio.run(main()) ``` -**Asynchronous Example:** +
+ +
+Synchronous ```python -from pytonapi import AsyncTonapi +from pytonapi import Tonapi -# Declare an asynchronous function for using await -async def main(): +def main(): # Create a new Tonapi object with the provided API key - tonapi = AsyncTonapi(api_key="Your API key") + tonapi = Tonapi(api_key="Your API key") # Specify the account ID account_id = "EQC-3ilVr-W0Uc3pLrGJElwSaFxvhXXfkiQA3EwdVBHNNess" # noqa - # Retrieve account information asynchronously - account = await tonapi.accounts.get_info(account_id=account_id) + # Retrieve account information + account = tonapi.accounts.get_info(account_id=account_id) # Print account details print(f"Account Address (raw): {account.address.to_raw()}") @@ -94,18 +108,34 @@ async def main(): if __name__ == '__main__': - import asyncio - - # Run the asynchronous function - asyncio.run(main()) + main() ``` -**More Examples:**\ -Additional examples can be found in the [examples](examples) folder. +
+ + +
+More + +* Additional examples can be found [examples](https://github.com/tonkeeper/pytonapi/tree/main/examples) folder. + +
+ +## Contribution + +We welcome your contributions! If you have ideas for improvement or have identified a bug, please create an issue or +submit a pull request. + +## Donations + +**TON** - `EQC-3ilVr-W0Uc3pLrGJElwSaFxvhXXfkiQA3EwdVBHNNess` + +**USDT** (TRC-20) - `TJjADKFT2i7jqNJAxkgeRm5o9uarcoLUeR` + +## License -## Donations: +This repository is distributed under the [MIT License](https://github.com/tonkeeper/pytonapi/blob/main/LICENSE). Feel +free to use, modify, and distribute the code in accordance +with the terms of the license. - -\ -```EQC-3ilVr-W0Uc3pLrGJElwSaFxvhXXfkiQA3EwdVBHNNess```