unitpulse-discovery 0.2.0

Backend-agnostic service discovery and registration SDK

unitpulse-discovery

Service registration and discovery SDK for Python microservices. Supports Nacos and Consul.

Installation

# With Nacos support
pip install "./unitpulse-discovery[nacos]"

# With all backends
pip install "./unitpulse-discovery[all]"

Usage

from unitpulse_discovery import setup_discovery

setup_discovery(app, backend="nacos", **NACOS_CONFIG)
app.discovery.initialize()

client = app.discovery.get_client()
client.register(service_name="my-service", host="10.0.0.1", port=8080, ephemeral=True)

On shutdown:

client.deregister("my-service", "10.0.0.1", 8080)

Parameters

setup_discovery(app, backend, **config)

Parameter	Type	Required	Description
app	Flask | FastAPI	Yes	App instance
backend	str	Yes	"nacos" or "consul"
**config			Backend-specific config (see below)

Nacos Config

Key	Type	Default	Description
server_addresses	str	—	Nacos server, e.g. "nacos-server:8848"
namespace	str	"public"	Nacos namespace ID
username	str	None	Auth username
password	str	None	Auth password
group_name	str	"DEFAULT_GROUP"	Service group
timeout	int	5	Request timeout (seconds)
service_name	str	None	Ignored by the backend; safe to include for config consolidation

client.register(...)

Parameter	Type	Default	Description
service_name	str	—	Service name to register
host	str	—	Instance IP
port	int	—	Instance port
metadata	dict	{}	Extra metadata (e.g. {"version": "1.0", "weight": 1})
ephemeral	bool	True	Temporary instance — requires heartbeat; auto-removed on crash
heartbeat_interval	int	5	Heartbeat interval in seconds (ephemeral only)

License

MIT