Skip to content

pymqrest

Overview

pymqrest provides a Python-friendly interface to IBM MQ queue manager administration via the runCommandJSON REST endpoint. It translates between Python snake_case attribute names and native MQSC parameter names, wraps every MQSC command as a typed method, and handles authentication, CSRF tokens, and error propagation.

Key features

  • ~144 command methods covering all MQSC verbs and qualifiers
  • Bidirectional attribute mapping between developer-friendly names and MQSC parameters
  • Idempotent ensure methods for declarative object management
  • Bulk sync operations for configuration-as-code workflows
  • Zero runtime dependencies — stdlib only
  • Transport abstraction for easy testing with mock transports

Installation

pip install pymqrest

Or with uv:

uv add pymqrest

Status

This project is in beta. The API surface, mapping tables, and return shapes are stable but may evolve.

License

GNU General Public License v3.0

Other languages

The mqrestadmin ecosystem provides the same MQSC-over-REST capability in multiple languages. Each implementation shares the mapping tables and test suites defined in mq-rest-admin-common.

Language Package Repository Documentation
Python pymqrest mq-rest-admin-python Docs
Ruby mq-rest-admin mq-rest-admin-ruby Docs
Java mq-rest-admin mq-rest-admin-java Docs
Go mqrestadmin mq-rest-admin-go Docs
Rust mq-rest-admin mq-rest-admin-rust Docs