awxkit

What it is and what it does

awxkit is the official Python client library and command-line tool for interacting with Ansible AWX, the upstream project for Red Hat Ansible Automation Platform. It wraps AWX's REST API, allowing developers and operators to programmatically manage jobs, inventories, credentials, and other AWX resources from Python code or shell scripts.

The package depends on PyYAML, requests, and setuptools, making it lightweight to install. It targets system administrators and developers who need to automate AWX operations or integrate AWX into larger automation workflows. However, the project is currently paused for a large-scale refactoring into a pluggable, service-oriented architecture; while the repository remains active, users should monitor the Ansible Forum for updates on API stability and breaking changes during this transition.

Use it for:

• Automate AWX job launches and monitoring from Python scripts or CI/CD pipelines.
• Programmatically manage AWX inventories, credentials, and templates via REST API without the web UI.
• Build custom integrations between AWX and external systems or monitoring tools.
• Batch operations on AWX resources (e.g., updating multiple job templates or credentials at once).
• Query AWX for job history, status, and execution logs in automation workflows.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

awxkit is the official command-line interface for Ansible AWX, providing programmatic access to AWX's REST API for automation and infrastructure management tasks.

Yes, if you need to automate AWX operations or integrate it into Python workflows. The package is stable, permissively licensed, and has low install friction. However, be aware that releases are paused during a large-scale refactoring, and two security vulnerabilities are known; verify their severity and applicability to your use case before deploying to production. Monitor the Ansible Forum for updates on the architectural changes.

Install

awxkit on PyPI

pip install awxkit

uv add awxkit

poetry add awxkit

Installing awxkit

Before you install

Low install friction with stable, permissive licensing. The project is in active maintenance but releases are paused during a large-scale refactoring; the last release was Jul 2, 2024. The repository remains active with recent commits, though users should be aware of ongoing architectural changes.

License in practice

Apache 2.0 is permissive, allowing commercial use, modification, and distribution with minimal restrictions. You may use this in proprietary projects and modify it freely, provided you include the license notice.

Quickstart

pip install awxkit

import awxkit
from awxkit.api import Client

client = Client(base_url='https://awx.example.com', username='admin', password='password')
me = client.get('/me').read()
print(me.username)

Requires Python 3.8 or later and a running AWX instance with network access and valid credentials.

Verify before relying

• Whether the refactoring pause affects API stability or backward compatibility for existing deployments
• Scope and timeline of the announced architectural changes and their impact on current awxkit users
• Details on the two known security vulnerabilities (GHSA-g29c-rgq6-gxgj, PYSEC-2026-3550) and their severity

Package facts

Evidence: awxkit-24.6.1-py3-none-any.whl

Tags

More Systems Administration packages