consulate

What it is and what it does

Consulate is a Python client for Consul, the service discovery and configuration system. It provides a library API and command-line tools to interact with Consul's core features: registering and deregistering services, managing the distributed key-value store, querying health status, and acquiring distributed locks. The library exposes these operations through a clean Python interface (e.g., `consul.kv['key'] = value`) and CLI commands for operational tasks like backing up and restoring the KV database.

The package has no runtime dependencies and installs with low friction. However, it has been abandoned since 2015-07-22 and was originally built for Python 2.6–3.4. Compatibility with modern Python versions and current Consul API versions is uncertain. It remains in beta status and is suitable only for legacy systems or environments where Consul version compatibility is known and tested.

Use it for:

• Programmatically register and deregister microservices with Consul from Python applications.
• Store and retrieve configuration values from Consul's KV store in Python code.
• Query service health status and node information from Consul in monitoring or orchestration scripts.
• Implement distributed locking patterns using Consul's lock mechanism from Python.
• Backup and restore Consul's KV database via CLI commands for disaster recovery.

Worth the install?

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

Consulate is a Python client library for Consul, providing programmatic access to service registration, health checks, key-value storage, and distributed locking operations.

No. The package is abandoned (last release 2015-07-22, no recent commits), targets Python 2.6–3.4, and its compatibility with modern Python and current Consul versions is unverified. For new projects, use a maintained alternative. Only consider it for legacy systems where it has been tested and is known to work.

Install

consulate on PyPI

pip install consulate

uv add consulate

poetry add consulate

Installing consulate

Before you install

Installation is straightforward with no runtime dependencies. However, the package is abandoned—last release was 2015-07-22 and no commits have been recorded since. It was built for Python 2.6–3.4, so compatibility with modern Python versions is uncertain.

License in practice

Licensed under BSD (permissive), so commercial and private use are unrestricted. No license-related barriers to adoption.

Quickstart

pip install consulate

import consulate
consul = consulate.Consul()
consul.kv['my_key'] = 'my_value'
value = consul.kv['my_key']

Requires a running Consul server accessible at default settings, or configured via environment variables or constructor arguments.

Verify before relying

• Compatibility with Python versions released after 3.4 is unknown.
• Whether the package works with current Consul API versions is unverified.
• Support for optional Unix socket communication and its current functionality.

Package facts

Evidence: consulate-0.6.0-py2-none-any.whl

Tags

More Libraries packages