yarn-api-client

What it is and what it does

yarn-api-client is a Python wrapper around the Apache Hadoop YARN REST API, allowing programmatic access to cluster resources, job submission, application monitoring, and node management. It abstracts away HTTP details and provides classes like ResourceManager, ApplicationMaster, HistoryServer, and NodeManager that map to YARN's core components.

The package supports optional authentication via SimpleAuth, Kerberos/SPNEGO (through requests_kerberos or gssapi), and proxy configuration. It is designed for Python 3.6 through 3.10 and has low install friction, depending only on requests. However, it is no longer actively maintained—the last release was in November 2021 and the repository shows no commits since September 2022. Compatibility is explicitly tested only against Hadoop 3.2.1, 3.3.0, and 3.3.1; other versions may have API mismatches or missing functionality.

Use it for:

• Query cluster resource availability and capacity before submitting Hadoop jobs programmatically
• Monitor running YARN applications and retrieve job status, logs, and performance metrics from a Python service
• Manage application lifecycle (submit, kill, track) in Kerberized Hadoop environments via Python automation
• Build dashboards or reporting tools that aggregate YARN cluster state across multiple resource managers
• Integrate Hadoop job submission and tracking into Python-based data pipelines or orchestration frameworks

Worth the install?

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

Python client library for querying and managing Apache Hadoop YARN clusters via REST API, supporting resource managers, application masters, history servers, and node managers.

Yes, if you are working with Hadoop 3.2.1, 3.3.0, or 3.3.1 and need programmatic YARN API access from Python. The package is stable, has no known vulnerabilities, and low install friction. However, do not install if you require active maintenance, bug fixes, or compatibility with newer Hadoop versions—the project is abandoned and has not been updated since 2022-09-26. Verify that your Hadoop version is explicitly supported before committing to it.

Install

yarn-api-client on PyPI

pip install yarn-api-client

uv add yarn-api-client

poetry add yarn-api-client

Installing yarn-api-client

Before you install

Low install friction with a single dependency (requests). However, the package is in abandoned maintenance status with no releases since 2021-11-16. The last commit was 2022-09-26. Compatibility is explicitly limited to Apache Hadoop 3.2.1, 3.3.0, and 3.3.1; other versions may have API differences or broken functionality.

License in practice

BSD license is permissive, allowing commercial and private use with minimal restrictions. You may use, modify, and distribute this package freely provided you retain the license notice.

Quickstart

pip install yarn-api-client

from yarn_api_client import ResourceManager
rm = ResourceManager('https://127.0.0.2:5678')
cluster_info = rm.cluster_information()

Requires a running Hadoop YARN cluster accessible at the specified endpoint. Kerberos/SPNEGO authentication requires optional dependencies (requests_kerberos or gssapi) installed separately and valid Kerberos tickets in system cache.

Verify before relying

• Whether the package works reliably with Hadoop versions beyond 3.3.1 or with vendor variants like Hortonworks
• Current state of the CLI interface (documented as outdated and broken)
• Whether the package has been tested or used successfully in production since its last release in November 2021

Package facts

Evidence: yarn_api_client-1.0.3-py3-none-any.whl

Tags

More Distributed Computing packages