You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 1, 2021. It is now read-only.
> A first-party Python client for building excellent, relevant search experiences with [Elastic App Search](https://www.elastic.co/products/app-search).
7
6
8
7
## Contents
9
8
10
-
+[Getting started](#getting-started-)
11
-
+[Dependencies](#dependencies)
12
-
+[Usage](#usage)
13
-
+[Running tests](#running-tests)
14
-
+[FAQ](#faq-)
15
-
+[Contribute](#contribute-)
16
-
+[License](#license-)
9
+
-[Getting started](#getting-started-)
10
+
-[Dependencies](#dependencies)
11
+
-[Versioning](#versioning)
12
+
-[Usage](#usage)
13
+
-[Running tests](#running-tests)
14
+
-[FAQ](#faq-)
15
+
-[Contribute](#contribute-)
16
+
-[License](#license-)
17
17
18
-
***
18
+
---
19
19
20
20
## Getting started 🐣
21
21
@@ -33,9 +33,19 @@ python setup.py install
33
33
34
34
## Dependencies
35
35
36
-
+ Python 2.7 / Python 3.3
37
-
+[Requests](https://github.com/requests/requests)
38
-
+[PyJWT](https://github.com/jpadilla/pyjwt)
36
+
- Python 2.7 / Python 3.3
37
+
-[Requests](https://github.com/requests/requests)
38
+
-[PyJWT](https://github.com/jpadilla/pyjwt)
39
+
40
+
## Versioning
41
+
42
+
This client is versioned and released alongside App Search.
43
+
44
+
To guarantee compatibility, use the most recent version of this library within the major version of the corresponding App Search implementation.
45
+
46
+
For example, for App Search `7.3`, use `7.3` of this library or above, but not `8.0`.
47
+
48
+
If you are a [SaaS](https://app.swiftype.com/as) user, simply use the most recent version of this library.
39
49
40
50
## Usage
41
51
@@ -121,6 +131,7 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
Creating a search key that will only search over the body field.
@@ -394,8 +404,8 @@ You can checkout the [Elastic App Search community discuss forums](https://discu
394
404
395
405
We welcome contributors to the project. Before you begin, a couple notes:
396
406
397
-
+ Prior to opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/elastic/app-search-python/issues).
398
-
+ Please write simple code and concise documentation, when appropriate.
407
+
- Prior to opening a pull request, please create an issue to [discuss the scope of your proposal](https://github.com/elastic/app-search-python/issues).
408
+
- Please write simple code and concise documentation, when appropriate.
0 commit comments