Skip to content

v0.1.7

Choose a tag to compare

@exploreriii exploreriii released this 28 Oct 23:29
8c3aa16

Overview

v0.1.7 features mostly documentation and example improvements. It also introduces two new workflows, a checksum feature and a https://github.com/DataClass refactor.

New Documentation:

docs: added Rebasing and Signing section to signing.md with instructions for maintaining commit verification during rebase operations (#556)
[Add](docs: added) examples/account_id.py demonstrating AccountId class usage including creating standard AccountIds, parsing from strings, comparing instances, and creating AccountIds with public key aliases
docs: added Common issues guide for SDK developers at examples/sdk_developers/common_issues.md
docs: added documentation for resolving changelog conflicts in docs/common_issues.md
docs: added comprehensive changelog entry guide at docs/sdk_developers/changelog.md to help contributors create proper changelog entries (#532).
docs: added add initial testing guide
docs: workflow.md documenting key steps to creating a pull request (#605)
docs: added changelog conflict resolution examples to docs/common_issues.md
docs: added "One Issue Per Pull Request" section to examples/sdk_developers/common_issues.md.
docs: update pyproject.toml maintainers list.
docs: added to README a social follow section

Refactored Documentation:

docs: refactored examples/topic_create.py into modular functions for better readability and reuse.
docs: refactored examples/topic_create.py to be more modular by splitting functions and renaming create_topic() to main().
docs: refactored examples/transfer_hbar.py to improve modularity by separating transfer and balance query operations into dedicated functions
docs: refactored examples/topic_message_submit.py to be more modular
docs: refactored examples/transfer_nft.py to be more modular by isolating transfer logic.
docs: refactored examples/file_append.py into modular functions for better readability, reuse, and consistency across examples.
docs: refactored monolithic function in token_create_nft_infinite.py to multiple modular functions for better structure and ease.
docs: refactored query_balance.py into modular, reusable functions with setup_client(), create_account(), get_balance(), transfer_hbars(), and main() for improved readability, maintainability, and error handling.
docs: unified balance and transfer logging format — both now consistently display values in hbars for clarity.
docs: enhanced contributing section in README.md with resource links
docs: Improved the contributing section in the README.md file
docs: Use relative paths for internal GitHub links (#560).
– docs: Updated README.md/CHANGELOG.md and added blog.md, bud.md and setup.md (#474)

New Docstrings:

docs: added Google-style docstrings to CustomFractionalFee class and its methods in custom_fractional_fee.py.
docs: Added Google-style docstrings to CustomFixedFee class and its methods in custom_fixed_fee.py.
docs: Add Google-style docstrings to CustomRoyaltyFee class and its methods in custom_royalty_fee.py.
docs: Add Google-style docstrings to AbstractTokenTransferTransaction class and its methods in abstract_token_transfer_transaction.py.
docs: Add Google-style docstrings to TokenRelationship class and its methods in token_relationship.py.

New Fixes:

docs: Updated all occurrences of non-functional Discord invite links throughout the documentation with the new, stable Hyperledger and Hedera invite links (#603).
docs: Added direct links to Python SDK channel in Linux Foundation Decentralized Trust Discord back in
docs: renamed examples/nft_allowance.py to examples/account_allowance_nft.py for consistency with account class naming scheme
docs: renamed examples/hbar_allowance.py to examples/account_allowance_hbar.py for naming consistency
docs: renamed docs/sdk_developers/changelog.md to docs/sdk_developers/changelog_entry.md for clarity.

New Workflows

feat: added dependabot.yaml file to enable automated dependency management.
feat: added workflow for running example scripts.

New Features

feat: added checksum filed for TopicId, FileId, ContractId, ScheduleId class

New Refactors

refactor: refactored TopicId class to use https://github.com/DataClass decorator for reducing boilerplate code

What's Changed

  • fix: fix for code scanning alert no. 4: Workflow does not contain permissions by @exploreriii in #387
  • chore: Enhance contributing section with resource links by @nadineloepfe in #502
  • refactor: improve modularity of transfer_hbar.py example by @NayandG07 in #503
  • refactor: to increase modularity and readability by @prajeeta15 in #421
  • chore: refactor examples/topic_message_submit.py to be more modular by @Shashank0701-byte in #509
  • docs: Create common issues guide for SDK developers by @ambicuity in #512
  • docs(fees): Add Google-style docstrings to CustomFractionalFee by @Raja-89 in #493
  • chore: refactor examples/topic_create.py to be more modular by @DinethShakya23 in #519
  • chore: Configure Dependabot for GitHub Actions and pip by @rbarker-dev in #524
  • docs: Improve contributing section in README by @Pranay22077 in #522
  • docs: add guide for resolving changelog conflicts by @amritamishra01 in #529
  • feat: add type hints to setup_client() and create_new_account() functions by @Om7035 in #514
  • fix: Refactor transfer_nft example for modularity#497 by @Adityarya11 in #515
  • docs: Add 'One Issue Per Pull Request' to common_issues.md by @joepaulvilsan in #520
  • docs: Create changelog.md guide for SDK contributors (#532) by @ambicuity in #533
  • refactor: Rename hbar_allowance.py example file by @Pranay22077 in #540
  • docs: Add docstrings to custom_fixed_fee.py by @Pranay22077 in #539
  • docs: add examples/account_id.py demonstrating AccountId by @mollymont in #542
  • docs: Add docstrings to custom_royalty_fee.py by @Pranay22077 in #547
  • chore(examples): refactor topic_delete.py to be more modular by @Adityarya11 in #528
  • docs: rename nft_allowance.py to account_allowance_nft.py by @bhaskargurram-ai in #537
  • docs: Add docstrings to abstract_token_transfer_transaction.py by @Pranay22077 in #553
  • refactor: converted function in examples/token_create_nft_infinite into modular functions by @gg21-prog in #527
  • chore: add changelog conflict examples to common_issues.md by @Ananya44444 in #545
  • docs: Use relative paths for internal GitHub links (#560) by @Pranay22077 in #561
  • docs: Add Google-style docstrings to token_relationship.py by @Pranay22077 in #559
  • refactor: Make examples/topic_create.py modular by @msaadsbr in #513
  • chore: Update maintainers list and changelog by @riyadey27 in #525
  • refactor: modularize file_append example into setup, create, and appe… by @OnatadeTobi in #557
  • docs: add Rebasing and Signing section to signing.md by @sankhya007 in #558
  • feat(examples): modularize logging_example.py for better maintainability by @Pratyush2240 in #573
  • refactor: type id class refactor with dataclass decorator by @RaghavGanesh7 in #574
  • fix: remove deprecated snake_case aliases and _DeprecatedAliasesMixin (#428) by @BhuvanB404 in #446
  • feat: add initial testing guide structure by @Pranay22077 in #588
  • docs: clarify all commits must be signed in signing.md (#459) by @Zaki-Mohd in #464
  • feat: Added checksum field to remaining IDs by @manishdait in #422
  • fix: Type hints for topic-related transactions by @manishdait in #599
  • feat: Added workflow to run example script by @manishdait in #374
  • chore: new contributing guide, setup.md, blog.md and checklist.md by @nadineloepfe in #607
  • docs: Fix broken Discord links with stable Hyperledger/Hedera invites by @Raja-89 in #613
  • chore: bring back direct links to Python SDK discord by @nadineloepfe in #615
  • chore: workflow documentation by @exploreriii in #606
  • docs: Add concise star, watch, and fork instructions to README by @Raja-89 in #619
  • chore: Release 0.1.7 by @exploreriii in #621

New Contributors

Full Changelog: v0.1.6...v0.1.7