Metadata-Version: 2.1
Name: algobase
Version: 0.12.1
Summary: A type-safe Python library for interacting with assets on Algorand.
Home-page: https://github.com/code-alexander/algobase
License: Apache Software License 2.0
Author: algobase
Author-email: alexandercodes@proton.me
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: babel (>=2.14.0,<3.0.0)
Requires-Dist: cytoolz (>=0.12.2,<0.13.0)
Requires-Dist: fastapi (>=0.109.0,<0.110.0)
Requires-Dist: httpx (>=0.26.0,<0.27.0)
Requires-Dist: mypy (>=1.8.0,<2.0.0)
Requires-Dist: py-algorand-sdk (>=2.5.0,<3.0.0)
Requires-Dist: pydantic (>=2.5.3,<3.0.0)
Requires-Dist: pydantic-settings (>=2.1.0,<3.0.0)
Requires-Dist: pytest-httpx (==0.29.0)
Requires-Dist: returns (>=0.22.0,<0.23.0)
Requires-Dist: rich (>=13.7.0,<14.0.0)
Requires-Dist: typer[all] (>=0.9.0,<0.10.0)
Project-URL: Repository, https://github.com/code-alexander/algobase
Description-Content-Type: text/markdown

# algobase

<div align="center">

[![Build status](https://github.com/code-alexander/algobase/workflows/build/badge.svg?branch=main&event=push)](https://github.com/code-alexander/algobase/actions?query=workflow%3Abuild)
[![Python Version](https://img.shields.io/pypi/pyversions/algobase.svg)](https://pypi.org/project/algobase/)
[![Dependencies Status](https://img.shields.io/badge/dependencies-up%20to%20date-brightgreen.svg)](https://github.com/code-alexander/algobase/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Security: bandit](https://img.shields.io/badge/security-bandit-green.svg)](https://github.com/PyCQA/bandit)
[![Pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/code-alexander/algobase/blob/main/.pre-commit-config.yaml)
[![Semantic Versions](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--versions-e10079.svg)](https://github.com/code-alexander/algobase/releases)
[![License](https://img.shields.io/github/license/code-alexander/algobase)](https://github.com/code-alexander/algobase/blob/main/LICENSE)
![Coverage Report](assets/images/coverage.svg)

A type-safe Python library for interacting with assets on Algorand.

</div>

## 💡 Motivation

`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](https://arc.algorand.foundation/) standards.

algobase uses [Pydantic](https://github.com/pydantic/pydantic) to validate and serialise data, making it easier to integrate with other tools in the ecosystem like [FastAPI](https://github.com/tiangolo/fastapi) and [SQLModel](https://github.com/tiangolo/sqlmodel).

## ⚠️ Warning

This library is in the early stages of development.

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

## 📖 Documentation

[algobase docs](https://code-alexander.github.io/algobase/)

## 🚀 Features

### Development features

- Supports `Python 3.11` and higher.
- [`Poetry`](https://python-poetry.org/) as the dependencies manager. See configuration in [`pyproject.toml`](https://github.com/code-alexander/algobase/blob/main/pyproject.toml).
- Automatic codestyle with [`ruff`](https://github.com/astral-sh/ruff), [`pydocstyle`](https://github.com/PyCQA/pydocstyle) and [`pyupgrade`](https://github.com/asottile/pyupgrade).
- Ready-to-use [`pre-commit`](https://pre-commit.com/) hooks with code-formatting.
- Type checks with [`mypy`](https://mypy.readthedocs.io); security checks with [`safety`](https://github.com/pyupio/safety) and [`bandit`](https://github.com/PyCQA/bandit)
- Testing with [`pytest`](https://docs.pytest.org/en/latest/).
- Ready-to-use [`.editorconfig`](https://github.com/code-alexander/algobase/blob/main/.editorconfig), [`.dockerignore`](https://github.com/code-alexander/algobase/blob/main/.dockerignore), and [`.gitignore`](https://github.com/code-alexander/algobase/blob/main/.gitignore). You don't have to worry about those things.

### Deployment features

- `GitHub` integration: issue and PR templates.
- `Github Actions` with predefined [build workflow](https://github.com/code-alexander/algobase/blob/main/.github/workflows/build.yml) as the default CI/CD.
- Everything is already set up for security checks, codestyle checks, code formatting, testing, linting, docker builds, etc with [`Makefile`](https://github.com/code-alexander/algobase/blob/main/Makefile#L89). More details in [makefile-usage](#makefile-usage).
- [Dockerfile](https://github.com/code-alexander/algobase/blob/main/docker/Dockerfile) for your package.
- Always up-to-date dependencies with [`@dependabot`](https://dependabot.com/). You will only [enable it](https://docs.github.com/en/github/administering-a-repository/enabling-and-disabling-version-updates#enabling-github-dependabot-version-updates).
- Automatic drafts of new releases with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter). You may see the list of labels in [`release-drafter.yml`](https://github.com/code-alexander/algobase/blob/main/.github/release-drafter.yml). Works perfectly with [Semantic Versions](https://semver.org/) specification.

### Open source community features

- Ready-to-use [Pull Requests templates](https://github.com/code-alexander/algobase/blob/main/.github/PULL_REQUEST_TEMPLATE.md) and several [Issue templates](https://github.com/code-alexander/algobase/tree/main/.github/ISSUE_TEMPLATE).
- Files such as: `LICENSE`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `SECURITY.md` are generated automatically.
- [`Stale bot`](https://github.com/apps/stale) that closes abandoned issues after a period of inactivity. (You will only [need to setup free plan](https://github.com/marketplace/stale)). Configuration is [here](https://github.com/code-alexander/algobase/blob/main/.github/.stale.yml).
- [Semantic Versions](https://semver.org/) specification with [`Release Drafter`](https://github.com/marketplace/actions/release-drafter).

## Installation

```bash
pip install -U algobase
```

or install with `Poetry`

```bash
poetry add algobase
```

### Makefile usage

[`Makefile`](https://github.com/code-alexander/algobase/blob/main/Makefile) contains a lot of functions for faster development.

<details>
<summary>1. Download and remove Poetry</summary>
<p>

To download and install Poetry run:

```bash
make poetry-download
```

To uninstall

```bash
make poetry-remove
```

</p>
</details>

<details>
<summary>2. Install all dependencies and pre-commit hooks</summary>
<p>

Install requirements:

```bash
make install
```

Pre-commit hooks coulb be installed after `git init` via

```bash
make pre-commit-install
```

</p>
</details>

<details>
<summary>3. Codestyle</summary>
<p>

Automatic formatting uses `ruff`.

```bash
make codestyle

# or use synonym
make formatting
```

Codestyle checks only, without rewriting files:

```bash
make check-codestyle
```

> Note: `check-codestyle` uses `ruff` libraries.

Update all dev libraries to the latest version using one comand

```bash
make update-dev-deps
```

<details>
<summary>4. Code security</summary>
<p>

```bash
make check-safety
```

This command launches `Poetry` integrity checks as well as identifies security issues with `Safety` and `Bandit`.

```bash
make check-safety
```

</p>
</details>

</p>
</details>

<details>
<summary>5. Type checks</summary>
<p>

Run `mypy` static type checker

```bash
make mypy
```

</p>
</details>

<details>
<summary>6. Tests with coverage badges</summary>
<p>

Run `pytest`

```bash
make test
```

</p>
</details>

<details>
<summary>7. All linters</summary>
<p>

Of course there is a command to ~~rule~~ run all linters in one:

```bash
make lint
```

the same as:

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

</p>
</details>

<details>
<summary>8. Docker</summary>
<p>

```bash
make docker-build
```

which is equivalent to:

```bash
make docker-build VERSION=latest
```

Remove docker image with

```bash
make docker-remove
```

More information [about docker](https://github.com/code-alexander/algobase/tree/main/docker).

</p>
</details>

<details>
<summary>9. Cleanup</summary>
<p>
Delete pycache files

```bash
make pycache-remove
```

Remove package build

```bash
make build-remove
```

Delete .DS_STORE files

```bash
make dsstore-remove
```

Remove .mypycache

```bash
make mypycache-remove
```

Or to remove all above run:

```bash
make cleanup
```

</p>
</details>

## 📈 Releases

You can see the list of available releases on the [GitHub Releases](https://github.com/code-alexander/algobase/releases) page.

We follow [Semantic Versions](https://semver.org/) specification.

We use [`Release Drafter`](https://github.com/marketplace/actions/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.

### List of labels and corresponding titles

|               **Label**               |  **Title in Releases**  |
| :-----------------------------------: | :---------------------: |
|       `enhancement`, `feature`        |       🚀 Features       |
| `bug`, `refactoring`, `bugfix`, `fix` | 🔧 Fixes & Refactoring  |
|       `build`, `ci`, `testing`        | 📦 Build System & CI/CD |
|              `breaking`               |   💥 Breaking Changes   |
|            `documentation`            |    📝 Documentation     |
|            `dependencies`             | ⬆️ Dependencies updates |

You can update it in [`release-drafter.yml`](https://github.com/code-alexander/algobase/blob/main/.github/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.

## 📖 Additional Resources

- [ARC Token Standards Explained for NFT Creators](https://www.algorand.foundation/news/arc-token-standards-explained-for-nft-creators)
- [Algorand Requests for Comments (ARCs)](https://arc.algorand.foundation/)

## 🛡 License

[![License](https://img.shields.io/github/license/code-alexander/algobase)](https://github.com/code-alexander/algobase/blob/main/LICENSE)

This project is licensed under the terms of the `Apache Software License 2.0` license. See [LICENSE](https://github.com/code-alexander/algobase/blob/main/LICENSE) for more details.

## 📃 Citation

```bibtex
@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}}
}
```

## Credits [![🚀 Your next Python package needs a bleeding-edge project structure.](https://img.shields.io/badge/python--package--template-%F0%9F%9A%80-brightgreen)](https://github.com/TezRomacH/python-package-template)

This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)

