# 📦 Pytoniq Tools
[](https://ton.org)
[](https://pypi.python.org/pypi/pytoniq-tools)
[](https://github.com/nessshon/pytoniq-tools/blob/main/LICENSE)
**Pytoniq Tools** is a high-level OOP library for Python designed for interacting with the TON. It is built on
top of three of the most popular libraries for working with TON in
Python: [pytoniq](https://github.com/yungwine/pytoniq), [pytonapi](https://github.com/tonkeeper/pytonapi),
and [pytoncenter](https://github.com/Ton-Dynasty/pytoncenter). By integrating these libraries, pytoniq-tools offers a
convenient and flexible tool for developers.
## Installation
```bash
pip install pytoniq-tools
```
## Usage
### Providers
- #### **LiteClient**
Uses `LiteBalancer` from the [pytoniq](https://github.com/yungwine/pytoniq) library and interacts with the blockchain
via lite servers.\
For better performance, you can pass your own config from a private lite server, which can be acquired from the <a href="https://t.me/liteserver_bot" target="_blank">bot</a>.
<details>
<summary>Client Initialization</summary>
```python
from pytoniq_tools.client import LiteClient
config = None
IS_TESTNET = True
client = LiteClient(config=config, is_testnet=IS_TESTNET)
```
</details>
- #### **TonapiClient**
Uses `AsyncTonapi` from the [pytonapi](https://github.com/tonkeeper/pytonapi) library and interacts with the
blockchain via the tonapi.io API.\
To use you need to obtain an API key on the <a href="https://tonconsole.com" target="_blank">tonconsole.com</a>.
<details>
<summary>Client Initialization</summary>
```python
from pytoniq_tools.client import TonapiClient
API_KEY = ""
IS_TESTNET = True
client = TonapiClient(api_key=API_KEY, is_testnet=IS_TESTNET)
```
</details>
- #### **ToncenterClient**
Uses `AsyncTonCenterClientV3` from the [pytoncenter](https://github.com/Ton-Dynasty/pytoncenter) library and interacts
with the blockchain via the toncenter.com API.\
To use you need to obtain an API key from the <a href="https://t.me/tonapibot" target="_blank">bot</a>.
<details>
<summary>Client Initialization</summary>
```python
from pytoniq_tools.client import ToncenterClient
API_KEY = ""
IS_TESTNET = True
client = ToncenterClient(api_key=API_KEY, is_testnet=IS_TESTNET)
```
</details>
### Wallet Operation Guide
- [Create Wallet](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/create_wallet.py)
- [Deploy Wallet](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/deploy_wallet.py)
- [Encrypt Comment](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/encrypt_comment.py)
- ##### **Common Wallet**
- [Transfer TON](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/common/transfer_ton.py)
- [Transfer NFT](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/common/transfer_nft.py)
- [Transfer Jetton](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/common/transfer_jetton.py)
- [Batch Transfer TON](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/common/batch_transfer_ton.py)
- [Batch Transfer NFT](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/common/batch_transfer_nft.py)
- [Batch Transfer Jetton](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/common/batch_transfer_jetton.py)
- ##### **Highload Wallet**
- [Transfer TON](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/highload/transfer_ton.py)
- [Transfer NFT](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/highload/transfer_nft.py)
- [Transfer Jetton](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/highload/transfer_jetton.py)
### NFT Operations Guide
- ##### **Standard NFTs**
- [Deploy Collection](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/standard/deploy_collection.py)
- [Mint Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/standard/mint_item.py)
- [Batch Mint](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/standard/batch_mint.py)
- [Transfer Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/transfer_item.py)
- ##### **Editable NFTs**
- [Deploy Collection](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/deploy_collection.py)
- [Mint Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/mint_item.py)
- [Batch Mint](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/batch_mint.py)
- [Transfer Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/transfer_item.py)
- [Edit Item Content](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/edit_item_content.py)
- [Change Item Editorship](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/change_item_editorship.py)
- [Edit Collection Content](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/edit_collection_content.py)
- [Change Collection Owner](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/change_collection_owner.py)
- ##### **Soulbound NFTs**
- [Deploy Collection](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/soulbound/deploy_collection.py)
- [Mint Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/soulbound/mint_item.py)
- [Batch Mint](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/soulbound/batch_mint.py)
- [Revoke Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/soulbound/revoke_item.py)
- [Destroy Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/soulbound/destroy_item.py)
## 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
This repository is distributed under the [MIT License](https://github.com/nessshon/pytoniq-tools/blob/main/LICENSE).
Feel free to use, modify, and distribute the code in accordance with the terms of the license.
Raw data
{
"_id": null,
"home_page": "https://github.com/nessshon/pytoniq-tools/",
"name": "pytoniq-tools",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "nessshon",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e8/76/5ae6bd6234561e3845317a23a0928d8cb64e193682b4bc12243f677cf2c7/pytoniq-tools-0.1.1.tar.gz",
"platform": null,
"description": "# \ud83d\udce6 Pytoniq Tools\n\n[](https://ton.org)\n[](https://pypi.python.org/pypi/pytoniq-tools)\n\n[](https://github.com/nessshon/pytoniq-tools/blob/main/LICENSE)\n\n**Pytoniq Tools** is a high-level OOP library for Python designed for interacting with the TON. It is built on\ntop of three of the most popular libraries for working with TON in\nPython: [pytoniq](https://github.com/yungwine/pytoniq), [pytonapi](https://github.com/tonkeeper/pytonapi),\nand [pytoncenter](https://github.com/Ton-Dynasty/pytoncenter). By integrating these libraries, pytoniq-tools offers a\nconvenient and flexible tool for developers.\n\n\n\n\n## Installation\n\n```bash\npip install pytoniq-tools\n```\n\n## Usage\n\n### Providers\n\n- #### **LiteClient**\n Uses `LiteBalancer` from the [pytoniq](https://github.com/yungwine/pytoniq) library and interacts with the blockchain\n via lite servers.\\\n For better performance, you can pass your own config from a private lite server, which can be acquired from the <a href=\"https://t.me/liteserver_bot\" target=\"_blank\">bot</a>.\n\n <details>\n <summary>Client Initialization</summary>\n\n ```python\n from pytoniq_tools.client import LiteClient\n\n config = None\n IS_TESTNET = True\n client = LiteClient(config=config, is_testnet=IS_TESTNET)\n ```\n\n </details>\n\n- #### **TonapiClient**\n Uses `AsyncTonapi` from the [pytonapi](https://github.com/tonkeeper/pytonapi) library and interacts with the\n blockchain via the tonapi.io API.\\\n To use you need to obtain an API key on the <a href=\"https://tonconsole.com\" target=\"_blank\">tonconsole.com</a>.\n\n <details>\n <summary>Client Initialization</summary>\n\n ```python\n from pytoniq_tools.client import TonapiClient\n\n API_KEY = \"\"\n IS_TESTNET = True\n client = TonapiClient(api_key=API_KEY, is_testnet=IS_TESTNET)\n ```\n\n </details>\n\n- #### **ToncenterClient**\n Uses `AsyncTonCenterClientV3` from the [pytoncenter](https://github.com/Ton-Dynasty/pytoncenter) library and interacts\n with the blockchain via the toncenter.com API.\\\n To use you need to obtain an API key from the <a href=\"https://t.me/tonapibot\" target=\"_blank\">bot</a>.\n\n <details>\n <summary>Client Initialization</summary>\n\n ```python\n from pytoniq_tools.client import ToncenterClient\n\n API_KEY = \"\"\n IS_TESTNET = True\n client = ToncenterClient(api_key=API_KEY, is_testnet=IS_TESTNET)\n ```\n\n </details>\n\n### Wallet Operation Guide\n\n- [Create Wallet](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/create_wallet.py)\n- [Deploy Wallet](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/deploy_wallet.py)\n- [Encrypt Comment](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/encrypt_comment.py)\n\n- ##### **Common Wallet**\n\n - [Transfer TON](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/common/transfer_ton.py)\n - [Transfer NFT](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/common/transfer_nft.py)\n - [Transfer Jetton](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/common/transfer_jetton.py)\n - [Batch Transfer TON](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/common/batch_transfer_ton.py)\n - [Batch Transfer NFT](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/common/batch_transfer_nft.py)\n - [Batch Transfer Jetton](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/common/batch_transfer_jetton.py)\n\n- ##### **Highload Wallet**\n - [Transfer TON](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/highload/transfer_ton.py)\n - [Transfer NFT](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/highload/transfer_nft.py)\n - [Transfer Jetton](https://github.com/nessshon/pytoniq-tools/blob/main/examples/wallet/highload/transfer_jetton.py)\n\n### NFT Operations Guide\n \n- ##### **Standard NFTs**\n\n - [Deploy Collection](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/standard/deploy_collection.py)\n - [Mint Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/standard/mint_item.py)\n - [Batch Mint](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/standard/batch_mint.py)\n - [Transfer Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/transfer_item.py)\n\n- ##### **Editable NFTs**\n\n - [Deploy Collection](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/deploy_collection.py)\n - [Mint Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/mint_item.py)\n - [Batch Mint](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/batch_mint.py)\n - [Transfer Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/transfer_item.py)\n - [Edit Item Content](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/edit_item_content.py)\n - [Change Item Editorship](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/change_item_editorship.py)\n - [Edit Collection Content](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/edit_collection_content.py)\n - [Change Collection Owner](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/editbale/change_collection_owner.py)\n\n- ##### **Soulbound NFTs**\n\n - [Deploy Collection](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/soulbound/deploy_collection.py)\n - [Mint Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/soulbound/mint_item.py)\n - [Batch Mint](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/soulbound/batch_mint.py)\n - [Revoke Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/soulbound/revoke_item.py)\n - [Destroy Item](https://github.com/nessshon/pytoniq-tools/blob/main/examples/nft/soulbound/destroy_item.py)\n\n## Contribution\n\nWe welcome your contributions! If you have ideas for improvement or have identified a bug, please create an issue or\nsubmit a pull request.\n\n## Donations\n\n**TON** - `EQC-3ilVr-W0Uc3pLrGJElwSaFxvhXXfkiQA3EwdVBHNNess`\n\n**USDT** (TRC-20) - `TJjADKFT2i7jqNJAxkgeRm5o9uarcoLUeR`\n\n## License\n\nThis repository is distributed under the [MIT License](https://github.com/nessshon/pytoniq-tools/blob/main/LICENSE).\nFeel free to use, modify, and distribute the code in accordance with the terms of the license.\n",
"bugtrack_url": null,
"license": null,
"summary": "Pytoniq Tools is a high-level OOP library for Python designed for interacting with the TON. It is built on top of three of the most popular libraries for working with TON in Python: pytoniq, pytonapi, and pytoncenter.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/nessshon/pytoniq-tools/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "72b74079c4d36a6dfe15bda660d9f4b78c147723cfda0d677da7b199a663b36a",
"md5": "3116324f5c2f51171f225bd196233a65",
"sha256": "58ab63940711856ea67fda7e67f6bc212732e30e62e820566fcd18034df9fddb"
},
"downloads": -1,
"filename": "pytoniq_tools-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3116324f5c2f51171f225bd196233a65",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 36342,
"upload_time": "2024-07-28T14:40:31",
"upload_time_iso_8601": "2024-07-28T14:40:31.735410Z",
"url": "https://files.pythonhosted.org/packages/72/b7/4079c4d36a6dfe15bda660d9f4b78c147723cfda0d677da7b199a663b36a/pytoniq_tools-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e8765ae6bd6234561e3845317a23a0928d8cb64e193682b4bc12243f677cf2c7",
"md5": "09a8066a1d7ad2db17158bac790a49e7",
"sha256": "da63932e6c47f50da6cfccef63a9372a9b7167fb96b7f01838ea421e125d6478"
},
"downloads": -1,
"filename": "pytoniq-tools-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "09a8066a1d7ad2db17158bac790a49e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 23041,
"upload_time": "2024-07-28T14:40:33",
"upload_time_iso_8601": "2024-07-28T14:40:33.842621Z",
"url": "https://files.pythonhosted.org/packages/e8/76/5ae6bd6234561e3845317a23a0928d8cb64e193682b4bc12243f677cf2c7/pytoniq-tools-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-28 14:40:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nessshon",
"github_project": "pytoniq-tools",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pytoniq",
"specs": [
[
"~=",
"0.1.39"
]
]
},
{
"name": "pytoncenter",
"specs": [
[
"~=",
"0.0.14"
]
]
},
{
"name": "pytonapi",
"specs": [
[
"~=",
"0.3.2"
]
]
}
],
"lcname": "pytoniq-tools"
}
JSON
