# antelopy
![PyPI](https://img.shields.io/pypi/v/antelopy?label=PyPI) ![Workflow Badge](https://github.com/stuckatsixpm/antelopy/actions/workflows/main.yml/badge.svg?branch=main) ![Python version](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)
**Documentation:** [https://antelopy.stuckatsixpm.com](https://antelopy.stuckatsixpm.com)
**Source Code:** [https://github.com/stuckatsixpm/antelopy](https://github.com/stuckatsixpm/antelopy)
---
**antelopy** serializes transaction data for Antelope blockchains, integrating with existing Python packages for ease of use.
In the Antelope's Leap 3.1 release, the `abi_json_to_bin` endpoint was deprecated to ensure the integrity of transaction data. However, available options for interacting with Antelope chains with Python all rely on this endpoint for the serialization step. **antelopy** is designed to handle this process in a non-intrusive way, minimizing changes users of **aioeos** and **eospy** need to make.
## Key Features
- Serialize transaction data in preparation for transaction
- Read ABIs from the blockchain or file, with the option to save for reuse
- Integration wrappers around **aioeos** and **eospy**
**antelopy** supports the following libraries.
| Antelope Library | Support Status | Usage Guide | Repository |
| ---------------- | ------------------------------- | ----------------------- | --------------------------------------------- |
| **aioeos** | ✔ Fully integrated | [Link](usage/aioeos.md) | [Link](https://github.com/ulamlabs/aioeos/) |
| **eospy** | ✔ Fully integrated[^1] | [Link](usage/eospy.md) | [Link](https://github.com/eosnewyork/eospy) |
| **pyntelope** | ✘ Waiting for dependency update | N/A | [Link](https://github.com/FACINGS/pyntelope/) |
## Basic Usage:
### Installation
```bash
pip install antelopy
```
### Usage
Visit our [documentation](https://antelopy.stuckatsixpm.com) for various examples of how to use **antelopy**!
### Support
**antelopy** is possible thanks to funding from:
[![WAX Labs](docs/_resources/wax_labs_logo.svg)](https://labs.wax.io/)
Raw data
{
"_id": null,
"home_page": "https://antelopy.stuckatsixpm.com",
"name": "antelopy",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Jake Hattwell",
"author_email": "stuck@sixpm.dev",
"download_url": "https://files.pythonhosted.org/packages/ee/4e/df4a27c615320a63adc317bd535027264cab149806332ef5baa082ae49a9/antelopy-0.2.0.tar.gz",
"platform": null,
"description": "# antelopy\n\n![PyPI](https://img.shields.io/pypi/v/antelopy?label=PyPI) ![Workflow Badge](https://github.com/stuckatsixpm/antelopy/actions/workflows/main.yml/badge.svg?branch=main) ![Python version](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12-blue)\n\n**Documentation:** [https://antelopy.stuckatsixpm.com](https://antelopy.stuckatsixpm.com) \n**Source Code:** [https://github.com/stuckatsixpm/antelopy](https://github.com/stuckatsixpm/antelopy)\n\n---\n\n**antelopy** serializes transaction data for Antelope blockchains, integrating with existing Python packages for ease of use.\n\nIn the Antelope's Leap 3.1 release, the `abi_json_to_bin` endpoint was deprecated to ensure the integrity of transaction data. However, available options for interacting with Antelope chains with Python all rely on this endpoint for the serialization step. **antelopy** is designed to handle this process in a non-intrusive way, minimizing changes users of **aioeos** and **eospy** need to make.\n\n## Key Features\n\n- Serialize transaction data in preparation for transaction\n- Read ABIs from the blockchain or file, with the option to save for reuse\n- Integration wrappers around **aioeos** and **eospy**\n\n**antelopy** supports the following libraries.\n\n| Antelope Library | Support Status | Usage Guide | Repository |\n| ---------------- | ------------------------------- | ----------------------- | --------------------------------------------- |\n| **aioeos** | \u2714 Fully integrated | [Link](usage/aioeos.md) | [Link](https://github.com/ulamlabs/aioeos/) |\n| **eospy** | \u2714 Fully integrated[^1] | [Link](usage/eospy.md) | [Link](https://github.com/eosnewyork/eospy) |\n| **pyntelope** | \u2718 Waiting for dependency update | N/A | [Link](https://github.com/FACINGS/pyntelope/) |\n\n## Basic Usage:\n\n### Installation\n\n```bash\npip install antelopy\n```\n\n### Usage\n\nVisit our [documentation](https://antelopy.stuckatsixpm.com) for various examples of how to use **antelopy**!\n\n### Support\n**antelopy** is possible thanks to funding from:\n\n[![WAX Labs](docs/_resources/wax_labs_logo.svg)](https://labs.wax.io/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python helper for Antelope transaction serialization",
"version": "0.2.0",
"project_urls": {
"Documentation": "https://antelopy.stuckatsixpm.com",
"Homepage": "https://antelopy.stuckatsixpm.com",
"Repository": "https://github.com/stuckatsixpm/antelopy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dde4bff9bd566b69abbe10d71a4318cd57444c216ca4260ba18d29c5bf826866",
"md5": "0ad8bf5b4adb2b69b494ccff3018ee38",
"sha256": "4bfab2d503954f212a58492dd068b5f6043c04fbc58efc0c966fcd82354aade1"
},
"downloads": -1,
"filename": "antelopy-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ad8bf5b4adb2b69b494ccff3018ee38",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 19937,
"upload_time": "2024-02-12T07:41:25",
"upload_time_iso_8601": "2024-02-12T07:41:25.726406Z",
"url": "https://files.pythonhosted.org/packages/dd/e4/bff9bd566b69abbe10d71a4318cd57444c216ca4260ba18d29c5bf826866/antelopy-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ee4edf4a27c615320a63adc317bd535027264cab149806332ef5baa082ae49a9",
"md5": "a682aa085b5a67c2cc6808252a6f595a",
"sha256": "bd3cddaf1c715d4738b2ea900faa2449180b8124772353ea1065b4a38157af2f"
},
"downloads": -1,
"filename": "antelopy-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "a682aa085b5a67c2cc6808252a6f595a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 14751,
"upload_time": "2024-02-12T07:41:27",
"upload_time_iso_8601": "2024-02-12T07:41:27.862539Z",
"url": "https://files.pythonhosted.org/packages/ee/4e/df4a27c615320a63adc317bd535027264cab149806332ef5baa082ae49a9/antelopy-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-12 07:41:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "stuckatsixpm",
"github_project": "antelopy",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "antelopy"
}