Skip to main content

Armada Python Client


The Armada Python client wraps the gRPC services defined in submit.proto and events.proto.

It supports the following Armada features:

  • submitting, cancelling, and re-prioritising jobs, and
  • watching for job events.

Installation

These instructions are intended for end-users. If you wish to develop against armada_client, please see our documentation on contributing

PyPI

The Armada python client is available from armada_client. It can be installed with pip install armada-client. Documentation and examples of how to use the python can be found on the Armada libraries webpage.

Build from Git

Building from Git is a multi-step process unlike many other Python projects. This project extensively uses generated code, which is not committed into the repository.

Before beginning, ensure you have:

  • A working docker client, or docker-compatible client available under docker.
  • Network access to fetch docker images and go dependencies.

To generate all needed code, and install the python client:

  1. From the root of the repository, run mage buildPython
  2. Install the client using pip install client/python. It's strongly recommended you do this inside a virtualenv.

Metadata

Release files for armada-client 0.5.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for armada-client 0.5.1
File Interpreter ABI Platform
armada_client-0.5.1-py3-none-any.whl Python 3 none any Details

Release files / armada_client-0.5.1-py3-none-any.whl

Download URL armada_client-0.5.1-py3-none-any.whl
Size 238.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
99e3331321ddf2b60d3764ea3347a4f3e6a95de9ea71167b0a30caf58d80726f
BLAKE2b-256 checksum
How to use checksums
e05380874f02c89699e515a922d2679cc11e40d79a5b7863f84a89652f3618eb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

0.5.1 This release

1 release file

0.5.0

1 release file

0.4.14

1 release file

0.4.13

1 release file

0.4.12

1 release file

0.4.11

1 release file

0.4.10

1 release file

0.4.8

1 release file

0.4.7

1 release file

0.4.6

1 release file

0.4.5

1 release file

0.3.5

1 release file

0.3.4

1 release file

0.3.3

1 release file

0.3.2

1 release file

0.3.1

1 release file

0.3.0

1 release file

0.2.9

1 release file

0.2.8

1 release file

0.2.7

1 release file

0.2.6

1 release file

0.2.5

1 release file

0.2.4

1 release file

0.2.3

1 release file

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page