algobase aims to provide a first-class developer experience for creating, managing, and querying Algorand ASAs.

It's designed to be easy to use, extensible, and compliant with Algorand ARC standards.

algobase uses Pydantic to validate and serialise data, making it easier to integrate with other tools in the ecosystem like FastAPI and SQLModel.

This library is in the early stages of development.

The API is not stable and the code has not been audited.

algobase docs

• Supports Python 3.11 and higher.
• Poetry as the dependencies manager. See configuration in pyproject.toml.
• Automatic codestyle with ruff, pydocstyle and pyupgrade.
• Ready-to-use pre-commit hooks with code-formatting.
• Type checks with mypy; security checks with safety and bandit
• Testing with pytest.
• Ready-to-use .editorconfig, .dockerignore, and .gitignore. You don't have to worry about those things.

• GitHub integration: issue and PR templates.
• Github Actions with predefined build workflow as the default CI/CD.
• Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with Makefile. More details in makefile-usage.
• Dockerfile for your package.
• Always up-to-date dependencies with @dependabot. You will only enable it.
• Automatic drafts of new releases with Release Drafter. You may see the list of labels in release-drafter.yml. Works perfectly with Semantic Versions specification.

• Ready-to-use Pull Requests templates and several Issue templates.
• Files such as: LICENSE, CONTRIBUTING.md, CODE_OF_CONDUCT.md, and SECURITY.md are generated automatically.
• Stale bot that closes abandoned issues after a period of inactivity. (You will only need to setup free plan). Configuration is here.
• Semantic Versions specification with Release Drafter.

pip install -U algobase

or install with Poetry

poetry add algobase

Makefile contains a lot of functions for faster development.

make poetry-download

make poetry-remove

make install

make pre-commit-install

make codestyle

# or use synonym
make formatting

make check-codestyle

make update-dev-deps

make check-safety

make check-safety

make mypy

make test

make lint

make test && make check-codestyle && make mypy && make check-safety

make docker-build

make docker-build VERSION=latest

make docker-remove

make pycache-remove

make build-remove

make dsstore-remove

make mypycache-remove

make cleanup

You can see the list of available releases on the GitHub Releases page.

We follow Semantic Versions specification.

We use Release Drafter. As pull requests are merged, a draft release is kept up-to-date listing the changes, ready to publish when you’re ready. With the categories option, you can categorize pull requests in release notes using labels.

You can update it in release-drafter.yml.

GitHub creates the bug, enhancement, and documentation labels for you. Dependabot creates the dependencies label. Create the remaining labels on the Issues tab of your GitHub repository, when you need them.

• ARC Token Standards Explained for NFT Creators
• Algorand Requests for Comments (ARCs)

This project is licensed under the terms of the Apache Software License 2.0 license. See LICENSE for more details.

@misc{algobase,
  author = {code-alexander},
  title = {A type-safe Python library for interacting with assets on Algorand.},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/code-alexander/algobase}}
}

This project was generated with python-package-template