Skip to main content

Python client for Xapiand

Project description

Python Xapiand Client

Official low-level client for Xapiand. Its goal is to provide common ground for all Xapiand-related code in Python; because of this it tries to be opinion-free and very extendable.


Install the xapiand package with pip:

pip install xapiand

Example use

Simple use-case:

>>> from datetime import datetime
>>> from xapiand import Xapiand

# by default we connect to localhost:8880
>>> client = Xapiand()

# datetimes will be serialized
>>> client.index(index="my-index", id=42, body={"any": "data", "timestamp":})
{'#docid': 42, '#shard': 2 '_id': 42, '_version': 1, 'any': 'data', 'timestamp': '2019-07-18T09:04:54.182665'}

# and deserialized
>>> client.get(index="my-index", id=42)
{'#docid': 42, '#shard': 2 '_id': 42, '_version': 1, 'any': 'data', 'timestamp': '2019-07-18T09:04:54.182665'}

Full documentation.


The client's features include:

  • translating basic Python data types to and from msgpack
  • configurable automatic discovery of cluster nodes
  • persistent connections
  • load balancing (with pluggable selection strategy) across all available nodes
  • failed connection penalization (time based - failed connections won't be retried until a timeout is reached)
  • thread safety
  • pluggable architecture


Copyright 2018-2019 Dubalu LLC Copyright 2017 Xapiand

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

xapiand-0.1.4.tar.gz (40.9 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page