python-aur-api

A thin client for the AUR web API

Installation

Even though the repository is called python-aur-api, you should find it by the name aur-api in PyPI:

pip install aur-api

Usage

First, import the symbols you need from the aur package:

from aur import (
    ErrorResult, InfoResult, SearchBy, SearchResult,
    get_pkg_info, search_pkgbase_startswith, search_pkgname_startswith, search_pkg,
)

The package exposes four functions to interact with the AUR web API endpoints:

• get_pkg_info(pkgnames: list[str]) -> InfoResult|ErrorResult
• search_pkgbase_startswith(term: str) -> list[str]
• search_pkgname_startswith(term: str) -> list[str]
• search_pkg(term: str, search_by: SearchBy) -> SearchResult|ErrorResult

All fucntions make a request to the AUR and return a well-typed result object. You can check whether you got an error with the following code:

result = get_pkg_info([]) # An empty list will fail!
if isinstance(result, ErrorResult):
    print(f"The error was: {result.error}")

Check the tests/test_basic.py file for some simple examples.

Testing

You can run pytest to run the tests. Since this is a very small project, we strive to have 100% code coverage:

pytest --cov=src --cov-report=html --cov-branch --strict-markers