Skip to main content

# PyEQS [![Build Status](https://travis-ci.org/Yipit/pyeqs.svg?branch=master)](https://travis-ci.org/Yipit/pyeqs) [![Coverage Status](https://coveralls.io/repos/Yipit/pyeqs/badge.png)](https://coveralls.io/r/Yipit/pyeqs)

#### Python Elasticsearch QuerySets

A python library to simplify building complex Elasticsearch JSON queries. Based on the Django QuerySet API, backed by the [official python elasticsearch library](https://github.com/elasticsearch/elasticsearch-py). Supports Elasticsearch 1.0+.

This is an attempt to provide an interface familiar to users of Django Querysets. Due to the differences in the backends it was impossible to mirror the Queryset API and maintain full search functionality. Be aware when using this library that the interfaces may not have the same trade-offs and caveats.

#### Current Development Status

Currently pre v1.0, so the API is not locked in. This project aims to follow [semantic versioning](http://semver.org/) once it reaches a stable API. Issues may arise as the backend elasticsearch-py library locks its versions to Elasticsearch releases.

## Installation

`bash pip install pyeqs `

## Usage

Check out the [API Reference](https://github.com/Yipit/pyeqs/blob/master/API_REFERENCE.md) for examples.

## Alternatives

#### Python * [ElasticUtils](http://elasticutils.readthedocs.org/en/latest/): A library by Mozilla uses a syntax leveraging built-in &, | and ~ to construct queries. * [Elasticsearch-dsl-py](https://github.com/elasticsearch/elasticsearch-dsl-py): A library by Elasticsearch that is similar and compatible with ElasticUtils. * [Django-Haystack](https://github.com/toastdriven/django-haystack): A library that wraps multiple search backends and presents them in the same interface as Django models. In my experience a very all-in-one solution that makes it hard to manipulate Elasticsearch directly, but wonderful when you need the feature set.

#### Ruby * [Plunk](https://github.com/elbii/plunk): A ruby library to allow you to write strings to queries that have more power than simple ‘query string’ requests

#### Haskell * [Bloodhound](https://github.com/bitemyapp/bloodhound/): A basic Elasticsearch Client that also has the ability to leverage the language’s built-in operators to construct queries.

#### Perl * [ElasticSearch::SearchBuilder](https://metacpan.org/pod/ElasticSearch::SearchBuilder): An Elasticsearch Client to help with constructing complex queries and filters.

Metadata

Release files for pyeqs 0.13.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyeqs 0.13.1
File Size Uploaded Provenance
pyeqs-0.13.1.tar.gz 9.3 kB Without provenance Details

Release files / pyeqs-0.13.1.tar.gz

Download URL pyeqs-0.13.1.tar.gz
Size 9.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d1678d01d2926fd4c93882f37b9ff5bce9308edf7941b86a7c5453900f115d47
BLAKE2b-256 checksum
How to use checksums
5b1650d52ccb10b2ddefe60a3bd974a000de73637ffb1cda7f6b69c000522ce4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for pyeqs 0.13.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page