Python client for the etcd v3 API for python >= 3.8
Project Links
Meta
Author: XuanYang-cn
Requires Python: >=3.8
Classifiers
Programming Language
- Python :: 3
License
- OSI Approved :: Apache Software License
Operating System
- OS Independent
pyetcd
Python client for the etcd API v3, supported python >= 3.7, under active maintenance
Install
pip install etcd-sdk-python
Basic usage:
import pyetcd
etcd = pyetcd.client()
etcd.get('foo')
etcd.put('bar', 'doot')
etcd.delete('bar')
# locks
lock = etcd.lock('thing')
lock.acquire()
# do something
lock.release()
with etcd.lock('doot-machine') as lock:
# do something
# transactions
etcd.transaction(
compare=[
etcd.transactions.value('/doot/testing') == 'doot',
etcd.transactions.version('/doot/testing') > 0,
],
success=[
etcd.transactions.put('/doot/testing', 'success'),
],
failure=[
etcd.transactions.put('/doot/testing', 'failure'),
]
)
# watch key
watch_count = 0
events_iterator, cancel = etcd.watch("/doot/watch")
for event in events_iterator:
print(event)
watch_count += 1
if watch_count > 10:
cancel()
# watch prefix
watch_count = 0
events_iterator, cancel = etcd.watch_prefix("/doot/watch/prefix/")
for event in events_iterator:
print(event)
watch_count += 1
if watch_count > 10:
cancel()
# recieve watch events via callback function
def watch_callback(event):
print(event)
watch_id = etcd.add_watch_callback("/anotherkey", watch_callback)
# cancel watch
etcd.cancel_watch(watch_id)
# recieve watch events for a prefix via callback function
def watch_callback(event):
print(event)
watch_id = etcd.add_watch_prefix_callback("/doot/watch/prefix/", watch_callback)
# cancel watch
etcd.cancel_watch(watch_id)
Dev
- Generate protos
make genproto
Credits
Many thx to python-etcd3
0.0.7
Aug 04, 2025
0.0.6
Mar 20, 2025
0.0.5
Mar 20, 2025
0.0.4
Sep 14, 2023
0.0.3
Jul 11, 2023
0.0.2
Jun 06, 2023
0.0.1
Apr 10, 2023