hiero-sdk-python 0.2.2__tar.gz → 0.2.3__tar.gz

hiero_sdk_python-0.2.3/PKG-INFO

@@ -0,0 +1,383 @@
+Metadata-Version: 2.1
+Name: hiero-sdk-python
+Version: 0.2.3
+Summary: A Hiero SDK in pure Python
+Author-Email: Nadine Loepfe <nadine.loepfe@hashgraph.com>, Richard Bair <rbair23@users.noreply.github.com>
+Maintainer-Email: Nadine Loepfe <nadine.loepfe@hashgraph.com>, Sophie Bulloch <exploreriii57@gmail.com>
+License:                                  Apache License
+                                    Version 2.0, January 2004
+                                 http://www.apache.org/licenses/
+         
+            TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+         
+            1. Definitions.
+         
+               "License" shall mean the terms and conditions for use, reproduction,
+               and distribution as defined by Sections 1 through 9 of this document.
+         
+               "Licensor" shall mean the copyright owner or entity authorized by
+               the copyright owner that is granting the License.
+         
+               "Legal Entity" shall mean the union of the acting entity and all
+               other entities that control, are controlled by, or are under common
+               control with that entity. For the purposes of this definition,
+               "control" means (i) the power, direct or indirect, to cause the
+               direction or management of such entity, whether by contract or
+               otherwise, or (ii) ownership of fifty percent (50%) or more of the
+               outstanding shares, or (iii) beneficial ownership of such entity.
+         
+               "You" (or "Your") shall mean an individual or Legal Entity
+               exercising permissions granted by this License.
+         
+               "Source" form shall mean the preferred form for making modifications,
+               including but not limited to software source code, documentation
+               source, and configuration files.
+         
+               "Object" form shall mean any form resulting from mechanical
+               transformation or translation of a Source form, including but
+               not limited to compiled object code, generated documentation,
+               and conversions to other media types.
+         
+               "Work" shall mean the work of authorship, whether in Source or
+               Object form, made available under the License, as indicated by a
+               copyright notice that is included in or attached to the work
+               (an example is provided in the Appendix below).
+         
+               "Derivative Works" shall mean any work, whether in Source or Object
+               form, that is based on (or derived from) the Work and for which the
+               editorial revisions, annotations, elaborations, or other modifications
+               represent, as a whole, an original work of authorship. For the purposes
+               of this License, Derivative Works shall not include works that remain
+               separable from, or merely link (or bind by name) to the interfaces of,
+               the Work and Derivative Works thereof.
+         
+               "Contribution" shall mean any work of authorship, including
+               the original version of the Work and any modifications or additions
+               to that Work or Derivative Works thereof, that is intentionally
+               submitted to Licensor for inclusion in the Work by the copyright owner
+               or by an individual or Legal Entity authorized to submit on behalf of
+               the copyright owner. For the purposes of this definition, "submitted"
+               means any form of electronic, verbal, or written communication sent
+               to the Licensor or its representatives, including but not limited to
+               communication on electronic mailing lists, source code control systems,
+               and issue tracking systems that are managed by, or on behalf of, the
+               Licensor for the purpose of discussing and improving the Work, but
+               excluding communication that is conspicuously marked or otherwise
+               designated in writing by the copyright owner as "Not a Contribution."
+         
+               "Contributor" shall mean Licensor and any individual or Legal Entity
+               on behalf of whom a Contribution has been received by Licensor and
+               subsequently incorporated within the Work.
+         
+            2. Grant of Copyright License. Subject to the terms and conditions of
+               this License, each Contributor hereby grants to You a perpetual,
+               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+               copyright license to reproduce, prepare Derivative Works of,
+               publicly display, publicly perform, sublicense, and distribute the
+               Work and such Derivative Works in Source or Object form.
+         
+            3. Grant of Patent License. Subject to the terms and conditions of
+               this License, each Contributor hereby grants to You a perpetual,
+               worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+               (except as stated in this section) patent license to make, have made,
+               use, offer to sell, sell, import, and otherwise transfer the Work,
+               where such license applies only to those patent claims licensable
+               by such Contributor that are necessarily infringed by their
+               Contribution(s) alone or by combination of their Contribution(s)
+               with the Work to which such Contribution(s) was submitted. If You
+               institute patent litigation against any entity (including a
+               cross-claim or counterclaim in a lawsuit) alleging that the Work
+               or a Contribution incorporated within the Work constitutes direct
+               or contributory patent infringement, then any patent licenses
+               granted to You under this License for that Work shall terminate
+               as of the date such litigation is filed.
+         
+            4. Redistribution. You may reproduce and distribute copies of the
+               Work or Derivative Works thereof in any medium, with or without
+               modifications, and in Source or Object form, provided that You
+               meet the following conditions:
+         
+               (a) You must give any other recipients of the Work or
+                   Derivative Works a copy of this License; and
+         
+               (b) You must cause any modified files to carry prominent notices
+                   stating that You changed the files; and
+         
+               (c) You must retain, in the Source form of any Derivative Works
+                   that You distribute, all copyright, patent, trademark, and
+                   attribution notices from the Source form of the Work,
+                   excluding those notices that do not pertain to any part of
+                   the Derivative Works; and
+         
+               (d) If the Work includes a "NOTICE" text file as part of its
+                   distribution, then any Derivative Works that You distribute must
+                   include a readable copy of the attribution notices contained
+                   within such NOTICE file, excluding those notices that do not
+                   pertain to any part of the Derivative Works, in at least one
+                   of the following places: within a NOTICE text file distributed
+                   as part of the Derivative Works; within the Source form or
+                   documentation, if provided along with the Derivative Works; or,
+                   within a display generated by the Derivative Works, if and
+                   wherever such third-party notices normally appear. The contents
+                   of the NOTICE file are for informational purposes only and
+                   do not modify the License. You may add Your own attribution
+                   notices within Derivative Works that You distribute, alongside
+                   or as an addendum to the NOTICE text from the Work, provided
+                   that such additional attribution notices cannot be construed
+                   as modifying the License.
+         
+               You may add Your own copyright statement to Your modifications and
+               may provide additional or different license terms and conditions
+               for use, reproduction, or distribution of Your modifications, or
+               for any such Derivative Works as a whole, provided Your use,
+               reproduction, and distribution of the Work otherwise complies with
+               the conditions stated in this License.
+         
+            5. Submission of Contributions. Unless You explicitly state otherwise,
+               any Contribution intentionally submitted for inclusion in the Work
+               by You to the Licensor shall be under the terms and conditions of
+               this License, without any additional terms or conditions.
+               Notwithstanding the above, nothing herein shall supersede or modify
+               the terms of any separate license agreement you may have executed
+               with Licensor regarding such Contributions.
+         
+            6. Trademarks. This License does not grant permission to use the trade
+               names, trademarks, service marks, or product names of the Licensor,
+               except as required for reasonable and customary use in describing the
+               origin of the Work and reproducing the content of the NOTICE file.
+         
+            7. Disclaimer of Warranty. Unless required by applicable law or
+               agreed to in writing, Licensor provides the Work (and each
+               Contributor provides its Contributions) on an "AS IS" BASIS,
+               WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+               implied, including, without limitation, any warranties or conditions
+               of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+               PARTICULAR PURPOSE. You are solely responsible for determining the
+               appropriateness of using or redistributing the Work and assume any
+               risks associated with Your exercise of permissions under this License.
+         
+            8. Limitation of Liability. In no event and under no legal theory,
+               whether in tort (including negligence), contract, or otherwise,
+               unless required by applicable law (such as deliberate and grossly
+               negligent acts) or agreed to in writing, shall any Contributor be
+               liable to You for damages, including any direct, indirect, special,
+               incidental, or consequential damages of any character arising as a
+               result of this License or out of the use or inability to use the
+               Work (including but not limited to damages for loss of goodwill,
+               work stoppage, computer failure or malfunction, or any and all
+               other commercial damages or losses), even if such Contributor
+               has been advised of the possibility of such damages.
+         
+            9. Accepting Warranty or Additional Liability. While redistributing
+               the Work or Derivative Works thereof, You may choose to offer,
+               and charge a fee for, acceptance of support, warranty, indemnity,
+               or other liability obligations and/or rights consistent with this
+               License. However, in accepting such obligations, You may act only
+               on Your own behalf and on Your sole responsibility, not on behalf
+               of any other Contributor, and only if You agree to indemnify,
+               defend, and hold each Contributor harmless for any liability
+               incurred by, or claims asserted against, such Contributor by reason
+               of your accepting any such warranty or additional liability.
+         
+            END OF TERMS AND CONDITIONS
+         
+            APPENDIX: How to apply the Apache License to your work.
+         
+               To apply the Apache License to your work, attach the following
+               boilerplate notice, with the fields enclosed by brackets "[]"
+               replaced with your own identifying information. (Don't include
+               the brackets!)  The text should be enclosed in the appropriate
+               comment syntax for the file format. We also recommend that a
+               file or class name and description of purpose be included on the
+               same "printed page" as the copyright notice for easier
+               identification within third-party archives.
+         
+            Copyright [yyyy] [name of copyright owner]
+         
+            Licensed under the Apache License, Version 2.0 (the "License");
+            you may not use this file except in compliance with the License.
+            You may obtain a copy of the License at
+         
+                http://www.apache.org/licenses/LICENSE-2.0
+         
+            Unless required by applicable law or agreed to in writing, software
+            distributed under the License is distributed on an "AS IS" BASIS,
+            WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+            See the License for the specific language governing permissions and
+            limitations under the License.
+         
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: <4,>=3.10
+Requires-Dist: protobuf<8,>=4.21.12
+Requires-Dist: grpcio<2,>=1.76.0
+Requires-Dist: cryptography<47,>=44.0.1
+Requires-Dist: requests<3,>=2.31.0
+Requires-Dist: pycryptodome<4,>=3.18.0
+Requires-Dist: eth-abi<6,>=5.1.0
+Requires-Dist: python-dotenv<3,>=1.2.1
+Provides-Extra: eth
+Requires-Dist: eth-keys<0.8,>=0.7.0; extra == "eth"
+Requires-Dist: rlp<5,>=4.0.1; extra == "eth"
+Provides-Extra: tck
+Requires-Dist: flask<4,>=3.0.0; extra == "tck"
+Description-Content-Type: text/markdown
+
+# Hiero SDK in Python
+
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/hiero-ledger/hiero-sdk-python/badge)](https://scorecard.dev/viewer/?uri=github.com/hiero-ledger/hiero-sdk-python)
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/10697/badge)](https://bestpractices.coreinfrastructure.org/projects/10697)
+[![License](https://img.shields.io/badge/license-apache2-blue.svg)](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/LICENSE)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/)
+
+A Python SDK for interacting with the Hedera Hashgraph platform.
+
+>**Python compatibility:** 
+> The SDK supports Python ≥ 3.10 and is tested on Python 3.10–3.14. Newer Python versions may work but have not yet been validated.
+
+## Quick Start
+
+### Installing from PyPI
+
+```bash
+pip install --upgrade pip
+pip install hiero-sdk-python
+pip install python-dotenv
+```
+
+### Environment Configuration
+
+Create a `.env` file in your project root with your Hedera testnet credentials.
+
+**Full setup instructions:** [Setup Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/setup.md)
+
+**Don't have testnet credentials?** Get them free at [Hedera Portal](https://portal.hedera.com/)
+
+A sample file is provided: [.env.example](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/.env.example)
+
+
+### Basic Usage
+
+```python
+import os
+from dotenv import load_dotenv
+from hiero_sdk_python import Network, Client, CryptoGetAccountBalanceQuery, AccountId, PrivateKey
+
+# Connect to testnet
+load_dotenv()
+network = Network("testnet")
+client = Client(network)
+
+operator_id = AccountId.from_string(os.getenv("OPERATOR_ID",""))
+operator_key = PrivateKey.from_string(os.getenv("OPERATOR_KEY",""))
+
+client.set_operator(operator_id, operator_key)
+
+# Query account balance
+balance = CryptoGetAccountBalanceQuery(account_id=operator_id).execute(client)
+print(f"Balance: {balance.hbars} HBAR")
+```
+
+---
+
+## Documentation
+
+### For SDK Users
+
+- **[Running Examples](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_users/running_examples.md)** - Complete guide to all SDK operations with code examples
+- **[Examples Directory](https://github.com/hiero-ledger/hiero-sdk-python/tree/main/examples)** - Ready-to-run example scripts
+
+### For SDK Developers
+
+- **[Contributing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/CONTRIBUTING.md)** - Start here!
+- **[Setup Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/setup.md)** - First-time environment setup
+- **[Windows Setup Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/setup_windows.md)** - Step-by-step guide for Windows users
+- **[Workflow Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/workflow.md)** - Day-to-day development workflow
+- **[Signing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/signing.md)** - GPG and DCO commit signing (required)
+- **[Changelog Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/changelog_entry.md)** - How to write changelog entries
+- **[Rebasing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/rebasing.md)** - Keep your branch up-to-date
+- **[Merge Conflicts Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/merge_conflicts.md)** - Resolve conflicts
+- **[Typing Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/types.md)** - Python type hints
+- **[Linting Guide](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/docs/sdk_developers/linting.md)** - Code quality tools
+
+### Hedera Network Resources
+
+- [Hedera Documentation](https://docs.hedera.com/)
+- [Hedera Protobufs](https://github.com/hashgraph/hedera-protobufs)
+- [Get Testnet Account](https://portal.hedera.com/) - Free testnet credentials
+- [Hedera Testnet Guide](https://docs.hedera.com/hedera/networks/testnet)
+
+### Other SDKs
+
+- [Hiero JavaScript SDK](https://github.com/hiero-ledger/hiero-sdk-js)
+- [Hiero Java SDK](https://github.com/hiero-ledger/hiero-sdk-java)
+- [Hiero Go SDK](https://github.com/hiero-ledger/hiero-sdk-go)
+
+---
+
+## Running Tests
+
+```bash
+uv run pytest
+```
+
+**For contributors:** Tests run automatically via [Hiero Solo Action](https://github.com/marketplace/actions/hiero-solo-action) when you push to a branch.
+
+**Learn more:**
+- [Testing with Hiero Solo](https://dev.to/hendrikebbers/ci-for-hedera-based-projects-2nja)
+
+---
+
+## Community & Support
+
+### Get Help
+
+- **Discord**: - [Linux Foundation Decentralized Trust Discord](https://discord.gg/hyperledger) (signed in users can use this [direct link to the Python SDK Channel](https://discord.com/channels/905194001349627914/1336494517544681563))
+- **General Hedera Support**: - [Hedera Developer Discord](https://discord.com/invite/hederahashgraph)
+- **Issues**: [GitHub Issues](https://github.com/hiero-ledger/hiero-sdk-python/issues)
+
+### Stay Updated
+
+- **Blog**: [Hiero Blog](https://hiero.org/blog/)
+- **Videos**: [LFDT YouTube Channel](https://www.youtube.com/@lfdecentralizedtrust/videos)
+- **Community Calls**: [Hiero Calendar](https://zoom-lfx.platform.linuxfoundation.org/meeting/92041330205?password=2f345bee-0c14-4dd5-9883-06fbc9c60581) (Wednesdays, 2pm UTC)
+
+---
+
+### ⭐ Follow Us
+
+If you find the Hiero Python SDK useful, here are three ways you can support the project and stay up-to-date **on the official repository page**: [**hiero-ledger/hiero-sdk-python**](https://github.com/hiero-ledger/hiero-sdk-python).
+
+* **Star the Repository:** Click **Star** to bookmark the project and show your support.
+* **Watch for Activity:** Click **Watch** to set your notification level, ensuring you stay updated on new features and releases.
+* **Fork the Project:** Click **Fork** to create your own copy, the first step for contributions.
+
+---
+
+## Contributions
+
+We welcome contributions! Whether you're:
+- 🐛 Reporting bugs
+- 💡 Suggesting features
+- 📝 Improving documentation
+- 💻 Writing code
+
+**Start here:** [CONTRIBUTING.md](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/CONTRIBUTING.md)
+
+---
+
+## License
+
+This project is licensed under the [Apache License 2.0](https://github.com/hiero-ledger/hiero-sdk-python/blob/main/LICENSE).
+
+---
+
+**Latest release:** Check [PyPI](https://pypi.org/project/hiero-sdk-python/) or [GitHub Releases](https://github.com/hiero-ledger/hiero-sdk-python/releases)

hiero_sdk_python-0.2.3/pyproject.toml

@@ -0,0 +1,129 @@
+[project]
+name = "hiero-sdk-python"
+dynamic = []
+description = "A Hiero SDK in pure Python"
+maintainers = [
+    { name = "Nadine Loepfe", email = "nadine.loepfe@hashgraph.com" },
+    { name = "Sophie Bulloch", email = "exploreriii57@gmail.com" },
+]
+authors = [
+    { name = "Nadine Loepfe", email = "nadine.loepfe@hashgraph.com" },
+    { name = "Richard Bair", email = "rbair23@users.noreply.github.com" },
+]
+readme = "README.md"
+requires-python = ">=3.10, <4"
+dependencies = [
+    "protobuf>=4.21.12,<8",
+    "grpcio>=1.76.0,<2",
+    "cryptography>=44.0.1,<47",
+    "requests>=2.31.0,<3",
+    "pycryptodome>=3.18.0,<4",
+    "eth-abi>=5.1.0,<6",
+    "python-dotenv>=1.2.1,<3",
+]
+classifiers = [
+    "Development Status :: 2 - Pre-Alpha",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+]
+version = "0.2.3"
+
+[project.license]
+file = "LICENSE"
+
+[project.optional-dependencies]
+eth = [
+    "eth-keys>=0.7.0,<0.8",
+    "rlp>=4.0.1,<5",
+]
+tck = [
+    "flask>=3.0.0,<4",
+]
+
+[dependency-groups]
+dev = [
+    "grpcio-tools>=1.76.0,<2",
+    "pytest>=8.3.4,<10",
+    "pytest-cov>=7.0.0,<8",
+    "hypothesis>=6.137.2",
+]
+lint = [
+    "ruff>=0.14.9,<1",
+    "mypy>=1.18.2,<2",
+    "typing-extensions>=4.15.0,<5",
+]
+
+[tool.uv]
+default-groups = [
+    "dev",
+    "lint",
+]
+
+[tool.setuptools_scm]
+version_scheme = "python-simplified-semver"
+local_scheme = "dirty-tag"
+
+[tool.pdm.version]
+source = "scm"
+
+[tool.pdm.build]
+package-dir = "src"
+excludes = [
+    "**/.pytest_cache",
+]
+
+[tool.pytest.ini_options]
+pythonpath = [
+    "src",
+    ".",
+]
+testpaths = [
+    "tests",
+]
+
+[tool.ruff]
+line-length = 120
+target-version = "py314"
+
+[tool.ruff.lint]
+select = [
+    "D",
+    "E",
+    "F",
+    "I",
+    "B",
+    "UP",
+    "SIM",
+    "PERF",
+    "ARG",
+    "RET",
+    "RSE",
+]
+ignore = [
+    "D212",
+    "E501",
+    "B008",
+]
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[build-system]
+requires = [
+    "pdm-backend",
+    "setuptools",
+    "setuptools_scm",
+    "grpcio-tools",
+]
+build-backend = "pdm.backend"