[Beginner]: Tidy set up client in examples

[exploreriii]

🐥 Beginner Friendly

Welcome! This Beginner Issue is designed to be a natural next step after good first issues.

It nudges you to:

• Research existing patterns
• Own more implementation decisions
• Test your changes

Difficulty:

• Requires knowledge of our workflow
• Beginner to intermediate Python and Git
• Beginner DLT/Blockchain experience

Important

We recommend completing at least 3 good first issues before attempting a beginner issue.

Tip

You should be comfortable with:

• Forking, branching, committing (with DCO + GPG signing), and opening a pull request without a tutorial
• Reading beginner Python code you did not write and following its patterns
• Handling simple merge conflicts in CHANGELOG.md
• Keeping your fork up to date with main by rebasing
• Looking things up on your own before asking for help

If any of that feels unfamiliar, good first issues might still be the most rewarding path
for you right now —
find one here.
You can always come back when you are ready.

Support: A maintainer actively monitors this issue and will help guide your implementation ideas.

⏱️ Typical time to complete: 4-6 hours
🧩 Difficulty: Manageable but requires investigation and testing
🎓 Best for: Beginner contributors

---

🏁 When this issue is complete, you will have:

✅ Improved your research abilities
✅ Improved your knowledge of the codebase
✅ Owned implementation decisions
✅ Created basic tests

👾 Description of the issue

We have various files in /examples that are manually setting up the client e.g

examples/account/account_allowance_approve_transaction_hbar.py
does:

def setup_client() -> Client:
    """Initialize and set up the client with operator account using env vars."""
    network = Network(network_name)
    print(f"Connecting to Hedera {network_name} network!")
    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)
    print(f"Client set up with operator id {client.operator_account_id}")

    return client

We now offer a simpler method eg:

def setup_client() -> Client:
    """Setup Client."""
    client = Client.from_env()
    print(f"Network: {client.network.network}")
    print(f"Client set up with operator id {client.operator_account_id}")
    return client

Before claiming:

• Check the issue labels to see what area this touches
• Read the CodeRabbit AI plan (posted as a comment) for a rough implementation overview
• If this feels like too big a step, that is fine — try another beginner issue or a Good First Issue first

💡 Solution

Update the set up client from manual to using the new method in client, in the example files

🔍 Background Research

You can understand this method by looking in the Client.py module, as well as some examples that use this eg.
examples/account/account_update_transaction.py

🛠️ Implementation

This is a large issue that requires updating the set up client examples throughout, robustly checking they work to run (you'll need a hedera portal testnet account and doing e.g. uv run examples/account/account_allowance_approve_transaction_hbar.py) and following good code principles

🧪 Testing your changes

How you test depends on the type of change.
See the testing guide for full details.

Source code changes (e.g. Python files in src/):

• Write unit tests and run them locally: uv run pytest tests/unit/<specific_file>_test.py -v
• Integration tests will run automatically when you push to your fork or open a PR

Example script changes (e.g. files in examples/):

• Run the example script to confirm it works: instructions are at the top of each script
• You will need a Hedera Portal account for testnet credentials — see environment setup
• Example changes do not require unit or integration tests

Workflow / GitHub Actions changes (e.g. files in .github/):

• Where possible, test by merging to your fork's main and simulating the scenario (e.g. creating a test issue or PR)
• Link to any test issues or PRs you created as evidence
• See the workflow testing guide

✅ Done Checklist

Before opening your PR, confirm:

• My changes address what the issue asked for — nothing more, nothing less
• I tested my changes locally (if relevant — see testing section above)
• My commits are signed: git commit -S -s -m "chore: description" — Signing guide
• I added a CHANGELOG.md entry under [Unreleased] — Changelog guide
• All CI checks pass

📋 Workflow quick reference

You have done this before — here are the links if you need them:

Step	Guide
Claim this issue	Comment /assign below
Sync with main	Rebasing guide
Open a PR and link this issue	PR guide · Linking guide
Resolve merge conflicts	Merge conflicts guide

🤖 Tips for using AI tools

Here is how to get the most out of AI tools:

• Use Pylance in VS Code to catch errors and hallucinated methods in real time
• Build your solution in small steps — add print statements or logs to confirm each piece works before moving on
• When AI suggests code, check it against existing examples and similar classes in the SDK — that is the best source of Python SDK-specific patterns. AI sometimes borrows from other SDKs.
• If AI output and SDK patterns disagree, trust the SDK

🆘 Stuck?

Beginner issues can be tricky — it is completely normal to get blocked. Here is what to do:

• Comment on this issue and describe what you have tried. A maintainer will respond.
• Ask on Discord in #hiero-python-sdk for quick questions.
• Join Office Hours (Wednesdays, 2pm UTC) for live, hands-on help with a maintainer — screen sharing welcome.

Do not spend more than 30 minutes blocked without asking. Asking good questions is a skill too.

📚 Resources

Project references:

• Project structure
• CONTRIBUTING.md
• Browse closed beginner PRs — see how others did it

Python references:

• Python official docs
• Data model (dunder methods)
• Type hints

[github-actions]

@coderabbitai plan

[coderabbitai]

Coding Plan

Summary

• Replace verbose manual client setup (8+ lines involving Network, AccountId, PrivateKey, set_operator) with single Client.from_env() call across ~35 example files
• Preserve specialized examples: multi-client demos get partial conversion (primary client only), TLS demo and documentation file are skipped entirely
• Clean up now-unnecessary imports (os, load_dotenv, Network, AccountId, PrivateKey) when they were only used for client setup
• Follow the established pattern from examples/account/account_update_transaction.py as the reference implementation

Design Choices

Design Choice 1: How to handle `logging_example.py` which uses `HEDERA_NETWORK` env var instead of `NETWORK`?

Options Considered:

1. Convert to Client.from_env() and accept that users must use NETWORK env var instead
2. Leave the file unconverted to preserve backward compatibility with HEDERA_NETWORK

Chosen Option: 1

Rationale: Convert the file since the ticket explicitly asks to update to the new pattern, and NETWORK is the standard env var name used throughout the codebase.

💡 User Tips

Regenerate the plan with different choices with @coderabbitai <feedback>.

Implementation Steps

Phase 1: Convert Standard Single-Client Examples

Convert all straightforward example files that use a single client with the standard manual setup pattern. This covers the majority of files across account, consensus, contract, file, prng, and schedule categories.

Task 1: Convert Account Examples

Convert the remaining account examples that still use manual setup to Client.from_env().

• Update examples/account/account_allowance_approve_transaction_hbar.py to use Client.from_env() pattern
• Update examples/account/account_allowance_approve_transaction_nft.py similarly
• Update examples/account/account_allowance_delete_transaction_hbar.py similarly
• Update examples/account/account_allowance_delete_transaction_nft.py similarly
• Update examples/account/account_records_query.py similarly
• Remove now-unnecessary imports: os, load_dotenv, Network, and AccountId/PrivateKey if only used for operator setup
• Remove module-level load_dotenv() calls and network_name variable declarations

Task 2: Convert Consensus Examples

Convert consensus topic examples to the new pattern.

• Update examples/consensus/topic_message_submit_chunked_transaction.py
• Update examples/consensus/topic_message_submit_transaction.py
• Update examples/consensus/topic_update_transaction.py
• Clean up unnecessary imports and module-level env var reads

Task 3: Convert Contract Examples

Convert all contract-related examples to the new pattern.

• Update examples/contract/contract_bytecode_query.py
• Update examples/contract/contract_call_query.py
• Update examples/contract/contract_create_transaction_no_constructor_parameters.py
• Update examples/contract/contract_create_transaction_with_bytecode.py
• Update examples/contract/contract_create_transaction_with_constructor_parameters.py
• Update examples/contract/contract_execute_transaction.py
• Update examples/contract/contract_execute_transaction_with_value.py
• Update examples/contract/contract_update_transaction.py
• Update examples/contract/ethereum_transaction.py
• Clean up unnecessary imports and module-level declarations

Task 4: Convert File Examples

Convert file service examples to the new pattern.

• Update examples/file/file_append_transaction.py
• Update examples/file/file_contents_query.py
• Update examples/file/file_delete_transaction.py
• Update examples/file/file_info_query.py
• Update examples/file/file_update_transaction.py
• Clean up unnecessary imports

Task 5: Convert Schedule and PRNG Examples

Convert scheduling and random number examples to the new pattern.

• Update examples/schedule/schedule_create_transaction.py
• Update examples/schedule/schedule_delete_transaction.py
• Update examples/schedule/schedule_info_query.py
• Update examples/schedule/schedule_sign_transaction.py
• Update examples/prng/prng_transaction.py
• Clean up unnecessary imports

🤖 Prompt for AI agents

Replace the old manual client setup pattern with `Client.from_env()` across all
standard single-client example files in the account, consensus, contract, file,
schedule, and prng categories.

For each file listed in the tasks below:
- Remove the old manual setup block, which typically spans 8+ lines and
involves:
  - `import os`
  - `from dotenv import load_dotenv`
  - `from hedera_sdk_python import Network, AccountId, PrivateKey` (or similar)
  - `load_dotenv()` call
  - `network_name = os.getenv(...)` variable declaration
- `Network(...)`, `AccountId.from_string(...)`, `PrivateKey.from_string(...)`
instantiations
  - `client.set_operator(...)` call
- Replace the entire block with a single `client = Client.from_env()` call
- Remove now-unnecessary imports: `os`, `load_dotenv`, `Network`, and
`AccountId`/`PrivateKey` **only if** they were solely used for operator setup
(preserve them if used elsewhere in the file)
- Use `examples/account/account_update_transaction.py` as the reference
implementation for the correct pattern

**Files to update:**

*Account:*
- `examples/account/account_allowance_approve_transaction_hbar.py`
- `examples/account/account_allowance_approve_transaction_nft.py`
- `examples/account/account_allowance_delete_transaction_hbar.py`
- `examples/account/account_allowance_delete_transaction_nft.py`
- `examples/account/account_records_query.py`

*Consensus:*
- `examples/consensus/topic_message_submit_chunked_transaction.py`
- `examples/consensus/topic_message_submit_transaction.py`
- `examples/consensus/topic_update_transaction.py`

*Contract:*
- `examples/contract/contract_bytecode_query.py`
- `examples/contract/contract_call_query.py`
- `examples/contract/contract_create_transaction_no_constructor_parameters.py`
- `examples/contract/contract_create_transaction_with_bytecode.py`
- `examples/contract/contract_create_transaction_with_constructor_parameters.py`
- `examples/contract/contract_execute_transaction.py`
- `examples/contract/contract_execute_transaction_with_value.py`
- `examples/contract/contract_update_transaction.py`
- `examples/contract/ethereum_transaction.py`

*File:*
- `examples/file/file_append_transaction.py`
- `examples/file/file_contents_query.py`
- `examples/file/file_delete_transaction.py`
- `examples/file/file_info_query.py`
- `examples/file/file_update_transaction.py`

*Schedule:*
- `examples/schedule/schedule_create_transaction.py`
- `examples/schedule/schedule_delete_transaction.py`
- `examples/schedule/schedule_info_query.py`
- `examples/schedule/schedule_sign_transaction.py`

*PRNG:*
- `examples/prng/prng_transaction.py`

Phase 2: Convert Transaction Examples and Special Cases

Handle transaction examples, including those with multiple clients or special configurations that require partial conversion or must be skipped.

Task 1: Convert Standard Transaction Examples

Convert straightforward transaction examples that use a single client.

• Update examples/transaction/batch_transaction.py
• Update examples/transaction/transaction_freeze_manually.py
• Update examples/transaction/transaction_to_bytes.py
• Update examples/transaction/transfer_transaction_fungible.py
• Update examples/transaction/transfer_transaction_gigabar.py
• Update examples/transaction/transfer_transaction_hbar.py
• Update examples/transaction/transfer_transaction_nft.py
• Update examples/transaction/transfer_transaction_tinybar.py
• Clean up unnecessary imports

Task 2: Partially Convert Multi-Client Transaction Examples

Update files that have multiple clients, converting only the primary executor client while preserving specialized secondary client creation.

• Update examples/transaction/transaction_freeze_without_operator.py: Convert setup_client() for primary executor to use Client.from_env(), but preserve create_client_without_operator() which intentionally creates a client without an operator
• Update examples/transaction/transaction_freeze_secondary_client.py: Convert setup_client() for primary executor, but preserve create_secondary_client() which creates credentials dynamically at runtime
• Keep Network import in these files since secondary client creation still needs it

Task 3: Convert Logger Example

Convert the logging example to the new pattern.

• Update examples/logger/logging_example.py to use Client.from_env() in setup_client()
• Note that this changes the expected env var from HEDERA_NETWORK to NETWORK
• Preserve all logging customization code in set_up_logging_level() which operates on the client after creation

Task 4: Document Skipped Files

Identify files that should NOT be converted and document why.

• Skip examples/client/client.py: This is an intentional documentation file that demonstrates both manual and from_env() patterns side-by-side for educational purposes
• Skip examples/tls_query_balance.py: This example specifically demonstrates TLS configuration via set_transport_security() and set_verify_certificates() based on VERIFY_CERTS env var, which Client.from_env() does not support

🤖 Prompt for AI agents

This phase handles transaction examples and special cases, including standard
single-client conversions, partial conversions for multi-client files, and the
logger example. No files are to be modified for the skipped files task.

**Standard transaction examples** — Apply the same replacement pattern as Phase
1 (remove manual setup block, replace with `Client.from_env()`, clean up unused
imports) for:
- `examples/transaction/batch_transaction.py`
- `examples/transaction/transaction_freeze_manually.py`
- `examples/transaction/transaction_to_bytes.py`
- `examples/transaction/transfer_transaction_fungible.py`
- `examples/transaction/transfer_transaction_gigabar.py`
- `examples/transaction/transfer_transaction_hbar.py`
- `examples/transaction/transfer_transaction_nft.py`
- `examples/transaction/transfer_transaction_tinybar.py`

**Multi-client transaction examples** — Apply partial conversion only:
- `examples/transaction/transaction_freeze_without_operator.py`:
  - Convert only the `setup_client()` function to use `Client.from_env()`
- Do NOT modify `create_client_without_operator()` — it intentionally creates a
client without an operator
- Retain the `Network` import since it is still needed by the secondary client
function
- `examples/transaction/transaction_freeze_secondary_client.py`:
  - Convert only the `setup_client()` function to use `Client.from_env()`
- Do NOT modify `create_secondary_client()` — it creates credentials dynamically
at runtime
- Retain the `Network` import since it is still needed by the secondary client
function

**Logger example:**
- `examples/logger/logging_example.py`:
  - In `setup_client()`, replace the manual setup block with `Client.from_env()`
- Remove now-unnecessary imports (`os`, `load_dotenv`, `Network`, `AccountId`,
`PrivateKey`) if they were only used for client setup
- Do NOT modify `set_up_logging_level()` — all logging customization that
operates on the client after creation must be preserved
- Be aware this changes the expected env var from `HEDERA_NETWORK` to `NETWORK`

**Skipped files** — Make NO changes to:
- `examples/client/client.py` (intentional documentation file showing both
patterns)
- `examples/tls_query_balance.py` (demonstrates TLS configuration not supported
by `Client.from_env()`)

Phase 3: Testing and Finalization

Verify all converted examples work correctly and complete the PR requirements.

Task 1: Test Converted Examples

Run each converted example against testnet to verify correct operation.

• Set up testnet credentials from Hedera Portal in .env file
• Run representative examples from each category using uv run examples/<path>/<filename>.py
• Verify examples execute without import errors or runtime failures
• Check that operator ID and network are correctly displayed in console output

Task 2: Add CHANGELOG Entry

Document the changes in the project changelog.

• Add entry under [Unreleased] section in CHANGELOG.md
• Describe that example files have been updated to use Client.from_env() for simplified client setup
• Follow existing changelog format and conventions

🤖 Prompt for AI agents

This phase covers verification and documentation finalization after all code
changes have been made.

**Test converted examples:**
- Ensure a `.env` file is configured with testnet credentials from the Hedera
Portal
- Run representative examples from each converted category using: `uv run
examples/<path>/<filename>.py`
- Confirm each example runs without import errors or runtime failures
- Verify that operator ID and network are correctly displayed in console output

**Add CHANGELOG entry:**
- Open `CHANGELOG.md` and locate the `[Unreleased]` section
- Add a new entry describing that example files across the `examples/` directory
have been updated to use `Client.from_env()` for simplified client setup
- Follow the existing changelog format and conventions already present in the
file

Research

The SDK provides a Client.from_env() class method that encapsulates all client initialization logic—loading .env files, reading OPERATOR_ID, OPERATOR_KEY, and NETWORK environment variables, and setting the operator. Currently, 39 example files use the old manual pattern while 78 files already use Client.from_env(). The reference implementation is in examples/account/account_update_transaction.py. Some files require special handling: multi-client demos, TLS configuration examples, and intentional documentation files showing both patterns.

---

🚀 Next Steps

🤖 All AI agent prompts combined

Task: 1

Replace the old manual client setup pattern with `Client.from_env()` across all
standard single-client example files in the account, consensus, contract, file,
schedule, and prng categories.

For each file listed in the tasks below:
- Remove the old manual setup block, which typically spans 8+ lines and
involves:
  - `import os`
  - `from dotenv import load_dotenv`
  - `from hedera_sdk_python import Network, AccountId, PrivateKey` (or similar)
  - `load_dotenv()` call
  - `network_name = os.getenv(...)` variable declaration
- `Network(...)`, `AccountId.from_string(...)`, `PrivateKey.from_string(...)`
instantiations
  - `client.set_operator(...)` call
- Replace the entire block with a single `client = Client.from_env()` call
- Remove now-unnecessary imports: `os`, `load_dotenv`, `Network`, and
`AccountId`/`PrivateKey` **only if** they were solely used for operator setup
(preserve them if used elsewhere in the file)
- Use `examples/account/account_update_transaction.py` as the reference
implementation for the correct pattern

**Files to update:**

*Account:*
- `examples/account/account_allowance_approve_transaction_hbar.py`
- `examples/account/account_allowance_approve_transaction_nft.py`
- `examples/account/account_allowance_delete_transaction_hbar.py`
- `examples/account/account_allowance_delete_transaction_nft.py`
- `examples/account/account_records_query.py`

*Consensus:*
- `examples/consensus/topic_message_submit_chunked_transaction.py`
- `examples/consensus/topic_message_submit_transaction.py`
- `examples/consensus/topic_update_transaction.py`

*Contract:*
- `examples/contract/contract_bytecode_query.py`
- `examples/contract/contract_call_query.py`
- `examples/contract/contract_create_transaction_no_constructor_parameters.py`
- `examples/contract/contract_create_transaction_with_bytecode.py`
- `examples/contract/contract_create_transaction_with_constructor_parameters.py`
- `examples/contract/contract_execute_transaction.py`
- `examples/contract/contract_execute_transaction_with_value.py`
- `examples/contract/contract_update_transaction.py`
- `examples/contract/ethereum_transaction.py`

*File:*
- `examples/file/file_append_transaction.py`
- `examples/file/file_contents_query.py`
- `examples/file/file_delete_transaction.py`
- `examples/file/file_info_query.py`
- `examples/file/file_update_transaction.py`

*Schedule:*
- `examples/schedule/schedule_create_transaction.py`
- `examples/schedule/schedule_delete_transaction.py`
- `examples/schedule/schedule_info_query.py`
- `examples/schedule/schedule_sign_transaction.py`

*PRNG:*
- `examples/prng/prng_transaction.py`
===============================================================================

Task: 2

This phase handles transaction examples and special cases, including standard
single-client conversions, partial conversions for multi-client files, and the
logger example. No files are to be modified for the skipped files task.

**Standard transaction examples** — Apply the same replacement pattern as Phase
1 (remove manual setup block, replace with `Client.from_env()`, clean up unused
imports) for:
- `examples/transaction/batch_transaction.py`
- `examples/transaction/transaction_freeze_manually.py`
- `examples/transaction/transaction_to_bytes.py`
- `examples/transaction/transfer_transaction_fungible.py`
- `examples/transaction/transfer_transaction_gigabar.py`
- `examples/transaction/transfer_transaction_hbar.py`
- `examples/transaction/transfer_transaction_nft.py`
- `examples/transaction/transfer_transaction_tinybar.py`

**Multi-client transaction examples** — Apply partial conversion only:
- `examples/transaction/transaction_freeze_without_operator.py`:
  - Convert only the `setup_client()` function to use `Client.from_env()`
- Do NOT modify `create_client_without_operator()` — it intentionally creates a
client without an operator
- Retain the `Network` import since it is still needed by the secondary client
function
- `examples/transaction/transaction_freeze_secondary_client.py`:
  - Convert only the `setup_client()` function to use `Client.from_env()`
- Do NOT modify `create_secondary_client()` — it creates credentials dynamically
at runtime
- Retain the `Network` import since it is still needed by the secondary client
function

**Logger example:**
- `examples/logger/logging_example.py`:
  - In `setup_client()`, replace the manual setup block with `Client.from_env()`
- Remove now-unnecessary imports (`os`, `load_dotenv`, `Network`, `AccountId`,
`PrivateKey`) if they were only used for client setup
- Do NOT modify `set_up_logging_level()` — all logging customization that
operates on the client after creation must be preserved
- Be aware this changes the expected env var from `HEDERA_NETWORK` to `NETWORK`

**Skipped files** — Make NO changes to:
- `examples/client/client.py` (intentional documentation file showing both
patterns)
- `examples/tls_query_balance.py` (demonstrates TLS configuration not supported
by `Client.from_env()`)
===============================================================================

Task: 3

This phase covers verification and documentation finalization after all code
changes have been made.

**Test converted examples:**
- Ensure a `.env` file is configured with testnet credentials from the Hedera
Portal
- Run representative examples from each converted category using: `uv run
examples/<path>/<filename>.py`
- Confirm each example runs without import errors or runtime failures
- Verify that operator ID and network are correctly displayed in console output

**Add CHANGELOG entry:**
- Open `CHANGELOG.md` and locate the `[Unreleased]` section
- Add a new entry describing that example files across the `examples/` directory
have been updated to use `Client.from_env()` for simplified client setup
- Follow the existing changelog format and conventions already present in the
file

💡 Iterate on the plan with: @coderabbitai <feedback>

Example Feedback
- `@coderabbitai` You can skip phase 3. Add a simple unit test case for phase 2.
- `@coderabbitai` For design choice 1 go ahead with option 3 and replan.

---

💬 Have feedback or questions? Drop into our discord!

[ParasSalonia]

/assign

[Omswastik-11]

@ParasSalonia are u still working on it ?

[ParasSalonia]

@Omswastik-11 yeah I am working on it. you can go for another issue in the repo which donot have any assignee.

[github-actions]

Hi @ParasSalonia 👋

This issue has been assigned but no pull request has been created yet.
Are you still planning on working on it?
If you are, please create a draft PR linked to this issue or comment /working to let us know.
If you’re no longer able to work on this issue, you can comment /unassign to release it.

From the Python SDK Team

[ParasSalonia]

/working