{"id":24465,"library":"python-zaqarclient","title":"python-zaqarclient (OpenStack Zaqar Client)","description":"python-zaqarclient is the official client library for the OpenStack Zaqar Messaging API (queuing and notification service). The current version is 4.4.0, requiring Python >=3.10. This library implements version 2 of the Zaqar API. Release cadence follows OpenStack coordinated releases.","status":"active","version":"4.4.0","language":"python","source_language":"en","source_url":"https://opendev.org/openstack/python-zaqarclient","tags":["openstack","zaqar","messaging","client"],"install":[{"cmd":"pip install python-zaqarclient","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Authentication for OpenStack endpoints (required).","package":"keystoneauth1","optional":false},{"reason":"Common utilities used by OpenStack libraries.","package":"oslo.utils","optional":false},{"reason":"Compatibility shim (deprecated but still required).","package":"six","optional":false}],"imports":[{"note":"ZaqarClient is not a top-level import; it must be imported from the client submodule.","wrong":"from zaqarclient import ZaqarClient","symbol":"ZaqarClient","correct":"from zaqarclient.client import ZaqarClient"},{"note":"Client is an alias for ZaqarClient; both can be used interchangeable.","wrong":"","symbol":"Client","correct":"from zaqarclient.client import Client"}],"quickstart":{"code":"import os\nfrom zaqarclient.client import ZaqarClient\n\n# Configuration for authentication\nconf = {\n    'auth_opts': {\n        'options': {\n            'os_auth_url': os.environ.get('OS_AUTH_URL', ''),\n            'os_username': os.environ.get('OS_USERNAME', ''),\n            'os_password': os.environ.get('OS_PASSWORD', ''),\n            'os_project_name': os.environ.get('OS_PROJECT_NAME', ''),\n        },\n        'auth_plugin': 'password',\n    },\n}\n\n# Connect to Zaqar endpoint\nzaqar_endpoint = os.environ.get('ZAQAR_ENDPOINT', '')\nclient = ZaqarClient(zaqar_endpoint, version=2, conf=conf)\n\n# Create a queue\nqueue = client.queue('example-queue', auto_create=True)\nprint(f\"Queue created: {queue.name}\")","lang":"python","description":"Connects to a Zaqar endpoint using OpenStack password authentication and creates a queue."},"warnings":[{"fix":"Pass version=2 when instantiating ZaqarClient or Client.","message":"The client automatically uses version 1 of the API if the 'version' parameter is not specified. Always explicitly set version=2 to use the current API.","severity":"gotcha","affected_versions":"<4.0.0"},{"fix":"Migrate to queue-level methods for subscriptions and claims.","message":"The 'claims' API and 'subscriptions' API are deprecated and will be removed in a future release. Use the equivalents from Zaqar 2.0 API (e.g., queue.subscriptions() instead of client.subscriptions()).","severity":"deprecated","affected_versions":">=4.0.0"},{"fix":"Upgrade to Python 3.10+.","message":"Python 3.10 or newer is required. The library no longer supports Python 2.7 or Python 3.6.","severity":"breaking","affected_versions":">=4.0.0"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Run 'pip install python-zaqarclient' and ensure import uses 'from zaqarclient.client import ZaqarClient'.","cause":"Package not installed or imported incorrectly.","error":"ModuleNotFoundError: No module named 'zaqarclient'"},{"fix":"Provide the endpoint URL and configuration dict: client = ZaqarClient(endpoint, version=2, conf=config)","cause":"Missing required arguments when creating ZaqarClient.","error":"TypeError: __init__() missing 2 required positional arguments: 'endpoint' and 'conf'"},{"fix":"Verify environment variables for OS_AUTH_URL, OS_USERNAME, etc., and check that the auth plugin is 'password'.","cause":"Authentication failure due to wrong credentials or misconfigured auth options.","error":"zaqarclient.transport.errors.TransportError: Expected HTTP 201 but received 401"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}