Merge pull request #3299 from XRPLF/python-get-started-code-walkthrough

Add Get Started Walkthrough for Python

Author: maria-robobug

_code-samples/get-started/py/README.md

@@ -0,0 +1,62 @@
+# Get Started Using Python Library
+
+Connects to the XRP Ledger and gets account information using Python.
+
+To download the source code, see [Get Started Using Python Library](http://xrpl.org/docs/tutorials/python/build-apps/get-started).
+
+## Run the Code
+
+Quick setup and usage:
+
+```sh
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+python ./get-acct-info.py
+```
+
+You should see output similar to the following:
+
+```sh
+Creating a new wallet and funding it with Testnet XRP...
+Attempting to fund address ravbHNootpSNQkxyEFCWevSkHsFGDHfyop
+Faucet fund successful.
+Wallet: ravbHNootpSNQkxyEFCWevSkHsFGDHfyop
+Account Testnet Explorer URL: 
+ https://testnet.xrpl.org/accounts/ravbHNootpSNQkxyEFCWevSkHsFGDHfyop
+
+Getting account info...
+Response Status:  ResponseStatus.SUCCESS
+{
+    "account_data": {
+        "Account": "ravbHNootpSNQkxyEFCWevSkHsFGDHfyop",
+        "Balance": "100000000",
+        "Flags": 0,
+        "LedgerEntryType": "AccountRoot",
+        "OwnerCount": 0,
+        "PreviousTxnID": "3DACF2438AD39F294C4EFF6132D5D88BCB65D2F2261C7650F40AC1F6A54C83EA",
+        "PreviousTxnLgrSeq": 12039759,
+        "Sequence": 12039759,
+        "index": "148E6F4B8E4C14018D679A2526200C292BDBC5AB77611BC3AE0CB97CD2FB84E5"
+    },
+    "account_flags": {
+        "allowTrustLineClawback": false,
+        "defaultRipple": false,
+        "depositAuth": false,
+        "disableMasterKey": false,
+        "disallowIncomingCheck": false,
+        "disallowIncomingNFTokenOffer": false,
+        "disallowIncomingPayChan": false,
+        "disallowIncomingTrustline": false,
+        "disallowIncomingXRP": false,
+        "globalFreeze": false,
+        "noFreeze": false,
+        "passwordSpent": false,
+        "requireAuthorization": false,
+        "requireDestinationTag": false
+    },
+    "ledger_hash": "CA624D717C4FCDD03BAD8C193F374A77A14F7D2566354A4E9617A8DAD896DE71",
+    "ledger_index": 12039759,
+    "validated": true
+}
+```

_code-samples/get-started/py/get-acct-info.py

@@ -1,34 +1,39 @@
+# @chunk {"steps": ["connect-tag"]}
 # Define the network client
 from xrpl.clients import JsonRpcClient
+from xrpl.wallet import generate_faucet_wallet
+from xrpl.core import addresscodec
+from xrpl.models.requests.account_info import AccountInfo
+import json
+
 JSON_RPC_URL = "https://s.altnet.rippletest.net:51234/"
 client = JsonRpcClient(JSON_RPC_URL)
+# @chunk-end
 
 
-# Create a wallet using the testnet faucet:
+# @chunk {"steps": ["get-account-create-wallet-tag"]}
+# Create a wallet using the Testnet faucet:
 # https://xrpl.org/xrp-testnet-faucet.html
-from xrpl.wallet import generate_faucet_wallet
+print("\nCreating a new wallet and funding it with Testnet XRP...")
 test_wallet = generate_faucet_wallet(client, debug=True)
-
-# Create an account str from the wallet
-test_account = test_wallet.address
-
-# Derive an x-address from the classic address:
-# https://xrpaddress.info/
-from xrpl.core import addresscodec
-test_xaddress = addresscodec.classic_address_to_xaddress(test_account, tag=12345, is_test_network=True)
-print("\nClassic address:\n\n", test_account)
-print("X-address:\n\n", test_xaddress)
+test_account = test_wallet.classic_address
+print(f"Wallet: {test_account}")
+print(f"Account Testnet Explorer URL: ")
+print(f" https://testnet.xrpl.org/accounts/{test_account}")
+# @chunk-end
 
 
+# @chunk {"steps": ["query-xrpl-tag"]}
 # Look up info about your account
-from xrpl.models.requests.account_info import AccountInfo
+print("\nGetting account info...")
 acct_info = AccountInfo(
     account=test_account,
     ledger_index="validated",
     strict=True,
 )
+
 response = client.request(acct_info)
 result = response.result
-print("response.status: ", response.status)
-import json
+print("Response Status: ", response.status)
 print(json.dumps(response.result, indent=4, sort_keys=True))
+# @chunk-end

_code-samples/get-started/py/requirements.txt

@@ -0,0 +1 @@
+xrpl-py==4.3.0