$ pip install etcd3-gateway

$ mkvirtualenv etcd3-gateway
$ pip install etcd3-gateway

from etcd3gw.client import Etcd3Client
client = Etcd3Client(host='localhost', port=2379)
# Put key
client.put(key='foo', value='bar')
# Get key
client.get(key='foo')
# Get all keys
client.get_all()
# Create lease and use it
lease = client.lease(ttl=100)
client.put(key='foo', value='bar', lease=lease)
# Get lease keys
lease.keys()
# Refresh lease
lease.refresh()
# Use watch
watcher, watch_cancel = client.watch(key='KEY')
for event in watcher: # blocks until event comes, cancel via watch_cancel()


    print(event)


    # modify event: {'kv': {'mod_revision': '8', 'version': '3', 'value': 'NEW_VAL', 'create_revision': '2', 'key': 'KEY', 'lease': '7587847878767953426'}}

property api_path

property base_url

create(key, value, lease=None)

Atomically create the given key only if the key doesn't exist.

This verifies that the create_revision of a key equales to 0, then creates the key with the value. This operation takes place in a transaction.

delete(key, **kwargs)

DeleteRange deletes the given range from the key-value store.

A delete request increments the revision of the key-value store and generates a delete event in the event history for every deleted key.

delete_prefix(key_prefix)

Delete a range of keys with a prefix in etcd.

get(key, metadata=False, sort_order=None, sort_target=None, **kwargs)

Range gets the keys in the range from the key-value store.

get_all(sort_order=None, sort_target='key')

Get all keys currently stored in etcd.

get_prefix(key_prefix, sort_order=None, sort_target=None)

Get a range of keys with a prefix.

get_url(path)

Construct a full url to the v3 API given a specific path

lease(ttl=30)

Create a Lease object given a timeout

lock(id=None, ttl=30)

Create a Lock object given an ID and timeout

members()

Lists all the members in the cluster.

post(*args, **kwargs)

helper method for HTTP POST

put(key, value, lease=None)

Put puts the given key into the key-value store.

A put request increments the revision of the key-value store and generates one event in the event history.

replace(key, initial_value, new_value)

Atomically replace the value of a key with a new value.

This compares the current value of a key, then replaces it with a new value if it is equal to a specified value. This operation takes place in a transaction.

status()

Status gets the status of the etcd cluster member.

transaction(txn)

Txn processes multiple requests in a single transaction.

A txn request increments the revision of the key-value store and generates events with the same revision for every completed request. It is not allowed to modify the same key several times within one txn.

watch(key, **kwargs)

Watch a key.

watch_once(key, timeout=None, **kwargs)

Watch a key and stops after the first event.

watch_prefix(key_prefix, **kwargs)

The same as watch, but watches a range of keys with a prefix.

watch_prefix_once(key_prefix, timeout=None, **kwargs)

Watches a range of keys with a prefix, similar to watch_once

keys()

Get the keys associated with this lease.

refresh()

LeaseKeepAlive keeps the lease alive

By streaming keep alive requests from the client to the server and streaming keep alive responses from the server to the client. This method makes a synchronous HTTP request by default.

revoke()

LeaseRevoke revokes a lease.

All keys attached to the lease will expire and be deleted. This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response.

ttl()

LeaseTimeToLive retrieves lease information.

This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please define a callback function to be invoked when receiving the response.

acquire()

Acquire the lock.

is_acquired()

Check if the lock is acquired

refresh()

Refresh the lease on the lock

release()

Release the lock

property uuid

The unique id of the lock