{"id":13425570,"url":"https://github.com/algorand/py-algorand-sdk","last_synced_at":"2025-05-16T05:04:29.865Z","repository":{"id":37275941,"uuid":"191575419","full_name":"algorand/py-algorand-sdk","owner":"algorand","description":"Algorand Python SDK","archived":false,"fork":false,"pushed_at":"2025-04-15T02:21:21.000Z","size":1339,"stargazers_count":272,"open_issues_count":27,"forks_count":143,"subscribers_count":15,"default_branch":"develop","last_synced_at":"2025-04-15T03:26:01.588Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/algorand.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-12T13:22:28.000Z","updated_at":"2025-02-24T11:52:33.000Z","dependencies_parsed_at":"2024-04-15T04:13:38.598Z","dependency_job_id":"ae04b491-8870-478c-8ab7-a8841b96b217","html_url":"https://github.com/algorand/py-algorand-sdk","commit_stats":{"total_commits":398,"total_committers":56,"mean_commits":7.107142857142857,"dds":0.7663316582914572,"last_synced_commit":"1b8ad21e372bfbe30bb4b7c7d5c4ec3cb90ff6c5"},"previous_names":[],"tags_count":41,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorand%2Fpy-algorand-sdk","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorand%2Fpy-algorand-sdk/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorand%2Fpy-algorand-sdk/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/algorand%2Fpy-algorand-sdk/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/algorand","download_url":"https://codeload.github.com/algorand/py-algorand-sdk/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254471060,"owners_count":22076585,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-07-31T00:01:14.975Z","updated_at":"2025-05-16T05:04:29.840Z","avatar_url":"https://github.com/algorand.png","language":"Python","funding_links":[],"categories":["Python","Development \u0026 Tools","Developer Resources","Development Tools","Cryptocurrencies"],"sub_categories":["Language SDKs \u0026 Tools","Tools","Languages"],"readme":"# py-algorand-sdk\n\n[![PyPI version](https://badge.fury.io/py/py-algorand-sdk.svg)](https://badge.fury.io/py/py-algorand-sdk)\n[![Documentation Status](https://readthedocs.org/projects/py-algorand-sdk/badge/?version=latest\u0026style=flat)](https://py-algorand-sdk.readthedocs.io/en/latest)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n\nA python library for interacting with the Algorand network.\n\n## Installation\n\nRun `$ pip3 install py-algorand-sdk` to install the package.\n\nAlternatively, choose a [distribution file](https://pypi.org/project/py-algorand-sdk/#files), and run `$ pip3 install [file name]`.\n\n## Supported Python versions\n\npy-algorand-sdk's minimum Python version policy attempts to balance several constraints.\n\n* Make it easy for the community to use py-algorand-sdk by minimizing or excluding the need to customize Python installations.\n* Provide maintainers with access to newer language features that produce more robust software.\n\nGiven these constraints, the minimum Python version policy is:\nTarget Python version on newest [Ubuntu LTS](https://wiki.ubuntu.com/Releases) released \u003e= 6 months ago.\n\nThe rationale is:\n\n* If a major Linux OS distribution bumps a Python version, then it's sufficiently available to the community for us to upgrade.\n* The 6 month time buffer ensures we delay upgrades until the community starts using a recently released LTS version.\n\n## SDK Development\n\nInstall dependencies\n\n* `pip3 install -r requirements.txt`\n\nRun tests\n\n* `make docker-test`\n\nSet up the Algorand Sandbox based test-harness without running the tests\n\n* `make harness`\n\nFormat code\n\n* `black .`\n\nUpdate `algosdk/__init__.pyi` which allows downstream developers importing `algosdk` and using VSCode's PyLance to have improved type analysis\n\n* `make generate-init`\n\nLint types\n\n* `make mypy` (or `mypy algosdk`)\n\nCheck all lints required by the C.I. process\n\n* `make lint`\n\nRun non-test-harness related unit tests\n\n* `make pytest-unit`\n\nWe use cucumber testing for all of our SDKs, including this one. Please refer to [algorand-sdk-testing](https://github.com/algorand/algorand-sdk-testing#readme) for guidance and existing tests that you may need to update. Depending on the type of update you wish to contribute, you may also need to have corresponding updates in the other SDKs (Go, JS, and Java). Feel welcome to ask for collaboration on that front. \n\n## Quick start\n\nHere's a simple example you can run without a node.\n\n```python\nfrom algosdk import account, encoding\n\n# generate an account\nprivate_key, address = account.generate_account()\nprint(\"Private key:\", private_key)\nprint(\"Address:\", address)\n\n# check if the address is valid\nif encoding.is_valid_address(address):\n    print(\"The address is valid!\")\nelse:\n    print(\"The address is invalid.\")\n```\n\n## Node setup\n\nFollow the instructions in Algorand's [developer resources](https://developer.algorand.org/docs/run-a-node/setup/install/) to install a node on your computer.\nYou can also set up a local [Algorand Sandbox](https://github.com/algorand/sandbox) with `make harness`.\n\n## Running examples/example.py\n\nBefore running [example.py](https://github.com/algorand/py-algorand-sdk/blob/master/examples/example.py), start kmd on a private network or testnet node:\n\n```bash\n./goal kmd start -d [data directory]\n```\n\nNext, create a wallet and an account:\n\n```bash\n./goal wallet new [wallet name] -d [data directory]\n```\n\n```bash\n./goal account new -d [data directory] -w [wallet name]\n```\n\nVisit the [Algorand dispenser](https://bank.testnet.algorand.network/) and enter the account address to fund your account.\n\nNext, in [tokens.py](https://github.com/algorand/py-algorand-sdk/blob/master/examples/tokens.py), either update the tokens and addresses, or provide a path to the data directory. Alternatively, `tokens.py` also defaults to the sandbox harness configurations for algod and kmd, which can be brought up by running `make harness`.\n\nYou're now ready to run example.py!\n\n## Documentation\n\nDocumentation for the Python SDK is available at [py-algorand-sdk.readthedocs.io](https://py-algorand-sdk.readthedocs.io/en/latest/).\n\n## License\n\npy-algorand-sdk is licensed under an MIT license. See the [LICENSE](https://github.com/algorand/py-algorand-sdk/blob/master/LICENSE) file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgorand%2Fpy-algorand-sdk","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falgorand%2Fpy-algorand-sdk","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falgorand%2Fpy-algorand-sdk/lists"}