awsync 0.3.1

An asynchronous, fully-typed AWS API library with a focus on being understandable, reliable, and maintainable.

awsync

An asynchronous, fully-typed AWS API library with a focus on being understandable, reliable, and maintainable.

NOTE: Currently a work in progress! Only a few API methods currently implemented for testing and development.

Usage

"Module main."
from asyncio import run
from httpx import AsyncClient

from awsync.client import Client
from awsync.models.aws import Region, Credentials


async def main() -> int:
    "Main function."
    async with AsyncClient() as httpx_client:
        client = Client(
            credentials=Credentials.from_environment(),
            httpx_client=httpx_client,
        )
        response = await client.list_stack_resources(
            region=Region.us_east_1, stack_name="Example-Stack-Name"
        )
        print(response)
    return 0


if __name__ == "__main__":
    run(main())

Local Developer Setup

Requirements:

• make
• python3
• poetry

Package Management

• make init install/update dependencies, alias for poetry install --sync.
• poetry add add a dependency ie. poetry add pydantic.
• poetry add -D add a development dependency ie. poetry add -D black.
• poetry remove remove a dependency ie. poetry remove pydantic.
• poetry shell activate the python virtual environment.
• exit exit the python virtual environment.

Repository Mangement

• make run runs the main module.
• make pr runs all pull request pre-checks below.
• make format runs code formatter.
• make lint checks code linting.
• make test runs tests.

Repository TODO:

• Code generation from JSON
• Automatic Publish CICD
• Documentation with mkDocs
• Test Makefile replacements
  • mise
  • Poetry run
  • doit