mpt-api-python-client

Python API client for the SoftwareONE Marketplace Platform (MPT) API.

Provides synchronous (MPTClient) and asynchronous (AsyncMPTClient) clients built on httpx, with typed resource services, mixin-based HTTP operations, and an RQL query builder.

Documentation

Start with these documents:

• AGENTS.md: AI-agent entry point and reading order
• docs/usage.md: installation, configuration, Python usage examples, and Docker-based commands
• docs/architecture.md: repository structure, layers, and key abstractions
• docs/local-development.md: Docker-only local setup and execution model
• docs/testing.md: repository-specific test strategy and commands
• docs/unit_tests.md: unit test structure and guidance
• docs/e2e_tests.md: end-to-end test setup and execution
• docs/contributing.md: repository-specific workflow and links to shared standards
• docs/documentation.md: repository-specific documentation rules
• docs/rql.md: fluent RQL query builder guide
• MPT OpenAPI Spec: upstream API contract

Quick Start

cp .env.sample .env   # configure MPT_API_BASE_URL
make build
make test

Use make help to inspect all supported Docker-based commands.

See docs/usage.md for installation details, sync and async examples, RQL usage, and Docker-based command examples.

Key Commands

make build      # build Docker development environment
make test       # run unit tests
make check      # run all quality checks (ruff, flake8, mypy)
make check-all  # run checks + tests
make format     # auto-format code
make bash       # open a shell in the container
make run        # start an IPython session