https://github.com/algorandfoundation/algokit-utils-py
https://github.com/algorandfoundation/algokit-utils-py
Last synced: 17 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/algorandfoundation/algokit-utils-py
- Owner: algorandfoundation
- License: mit
- Created: 2022-12-09T09:15:46.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-10T13:36:42.000Z (about 1 year ago)
- Last Synced: 2024-04-11T12:55:51.995Z (about 1 year ago)
- Language: Python
- Size: 3.59 MB
- Stars: 5
- Watchers: 4
- Forks: 4
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-algorand - algokit-utils-py - Algorand AlgoKit Utils for Python. (Core Resources / AlgoKit)
README
# AlgoKit Python Utilities
A set of core Algorand utilities written in Python and released via PyPi that make it easier to build solutions on Algorand.
This project is part of [AlgoKit](https://github.com/algorandfoundation/algokit-cli).
The goal of this library is to provide intuitive, productive utility functions that make it easier, quicker and safer to build applications on Algorand.
Largely these functions wrap the underlying Algorand SDK, but provide a higher level interface with sensible defaults and capabilities for common tasks.
> **Note**
> If you prefer TypeScript there's an equivalent [TypeScript utility library](https://github.com/algorandfoundation/algokit-utils-ts).
[Install](https://github.com/algorandfoundation/algokit-utils-py#install) | [Documentation](https://algorandfoundation.github.io/algokit-utils-py)
## Install
This library can be installed using pip, e.g.:
```
pip install algokit-utils
```
## Migration from `v2.x` to `v3.x`
Refer to the [v3 migration](./docs/source/v3-migration-guide.md) for more information on how to migrate to latest version of `algokit-utils-py`.
## Guiding principles
This library follows the [Guiding Principles of AlgoKit](https://github.com/algorandfoundation/algokit-cli/blob/main/docs/algokit.md#guiding-principles).
## Contributing
This is an open source project managed by the Algorand Foundation.
See the [AlgoKit contributing page](https://github.com/algorandfoundation/algokit-cli/blob/main/CONTRIBUTING.MD) to learn about making improvements.
To successfully run the tests in this repository you need to be running LocalNet via [AlgoKit](https://github.com/algorandfoundation/algokit-cli):
```
algokit localnet start
```