feat: Added workflow to run example script (#374)

Signed-off-by: Manish Dait <[email protected]>

Author: manishdait

.github/workflows/examples.yml

@@ -0,0 +1,46 @@
+name: Run Examples
+
+on:
+  push:
+    branches: 
+      - "**"
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  run-examples:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8
+        with:
+          fetch-depth: 0
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@1781c6eb42f98d67097986d30130a8ff6879fda2
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Generate Proto Files
+        run: uv run python generate_proto.py
+
+      - name: Prepare Hiero Solo
+        id: solo
+        uses: hiero-ledger/hiero-solo-action@6a1a77601cf3e69661fb6880530a4edf656b40d5 #v0.14.0
+        with:
+          installMirrorNode: true
+        
+      - name: Run Examples
+        env:
+          OPERATOR_ID: ${{ steps.solo.outputs.accountId }}
+          OPERATOR_KEY: ${{ steps.solo.outputs.privateKey }}
+          CHAIN_ID: 012A
+          NETWORK: solo
+        run: |
+          files=$(ls examples/*.py)
+          for file in $files;
+          do
+            echo -e "\n************ ${file} ************"
+            uv run -m examples.$(basename "$file" .py)
+          done

CHANGELOG.md

@@ -24,6 +24,7 @@ This changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.
 - docs: Add Google-style docstrings to `TokenRelationship` class and its methods in `token_relationship.py`.
 - feat: add initial testing guide structure
 - Added `checksum` filed for TopicId, FileId, ContractId, ScheduleId class
+- Added workflow for running example scripts.
 
 ### Changed
 

examples/account_allowance_hbar.py

@@ -20,7 +20,7 @@
 
 def setup_client():
     """Initialize and set up the client with operator account"""
-    network = Network(network="testnet")
+    network = Network(os.getenv('NETWORK'))
     client = Client(network)
 
     operator_id = AccountId.from_string(os.getenv("OPERATOR_ID"))

examples/account_allowance_nft.py

@@ -30,7 +30,7 @@
 
 def setup_client():
     """Initialize and set up the client with operator account"""
-    network = Network(network="testnet")
+    network = Network(os.getenv('NETWORK'))
     client = Client(network)
 
     operator_id = AccountId.from_string(os.getenv("OPERATOR_ID"))

examples/account_create.py

@@ -59,7 +59,7 @@ def setup_client() -> Tuple[Client, PrivateKey]:
         OPERATOR_ID (str): The account ID of the operator (format: "0.0.xxxxx")
         OPERATOR_KEY (str): The private key of the operator account
     """
-    network = Network(network='testnet')
+    network = Network(os.getenv('NETWORK'))
     client = Client(network)
 
     operator_id = AccountId.from_string(os.getenv('OPERATOR_ID'))

examples/account_delete.py

@@ -20,7 +20,7 @@
 
 def setup_client():
     """Initialize and set up the client with operator account"""
-    network = Network(network="testnet")
+    network = Network(os.getenv('NETWORK'))
     client = Client(network)
 
     operator_id = AccountId.from_string(os.getenv("OPERATOR_ID"))

examples/account_update.py

@@ -23,7 +23,7 @@
 
 def setup_client():
     """Initialize and set up the client with operator account"""
-    network = Network(network="testnet")
+    network = Network(os.getenv('NETWORK'))
     client = Client(network)
 
     operator_id = AccountId.from_string(os.getenv("OPERATOR_ID"))

examples/contract_create.py

@@ -36,7 +36,7 @@
 
 def setup_client():
     """Initialize and set up the client with operator account"""
-    network = Network(network="testnet")
+    network = Network(os.getenv('NETWORK'))
     client = Client(network)
 
     operator_id = AccountId.from_string(os.getenv("OPERATOR_ID"))

examples/contract_create_constructor.py

@@ -40,7 +40,7 @@
 
 def setup_client():
     """Initialize and set up the client with operator account"""
-    network = Network(network="testnet")
+    network = Network(os.getenv('NETWORK'))
     client = Client(network)
 
     operator_id = AccountId.from_string(os.getenv("OPERATOR_ID"))

examples/contract_create_with_bytecode.py

@@ -35,7 +35,7 @@
 
 def setup_client():
     """Initialize and set up the client with operator account"""
-    network = Network(network="testnet")
+    network = Network(os.getenv('NETWORK'))
     client = Client(network)
 
     operator_id = AccountId.from_string(os.getenv("OPERATOR_ID"))