Skip to content
This repository was archived by the owner on Sep 1, 2021. It is now read-only.

Commit 9734d8d

Browse files
authored
Release v7.2.0 (#14)
1 parent e4db416 commit 9734d8d

File tree

2 files changed

+26
-16
lines changed

2 files changed

+26
-16
lines changed

README.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
<p align="center"><a href="https://circleci.com/gh/elastic/app-search-python"><img src="https://circleci.com/gh/elastic/app-search-python.svg" alt="CircleCI build"></a>
44

5-
65
> A first-party Python client for building excellent, relevant search experiences with [Elastic App Search](https://www.elastic.co/products/app-search).
76
87
## Contents
98

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-)
1717

18-
***
18+
---
1919

2020
## Getting started 🐣
2121

@@ -33,9 +33,19 @@ python setup.py install
3333

3434
## Dependencies
3535

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.
3949

4050
## Usage
4151

@@ -121,6 +131,7 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
121131
```
122132

123133
### List Documents
134+
124135
```python
125136
>>> engine_name = 'favorite-videos'
126137
>>> client.list_documents(engine_name, current=1, size=20)
@@ -358,7 +369,6 @@ The client can be configured to use a managed deploy by adjusting the `base_endp
358369
>>> client.click(engine_name, {'query': 'cat', 'document_id': 'INscMGmhmX4'})
359370
```
360371

361-
362372
### Create a Signed Search Key
363373

364374
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
394404

395405
We welcome contributors to the project. Before you begin, a couple notes:
396406

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.
399409

400410
## License 📗
401411

elastic_app_search/__version__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
__title__ = 'elastic-app-search'
22
__description__ = 'An API client for Elastic App Search'
33
__url__ = 'https://github.com/elastic/app-search-python'
4-
__version__ = '0.7.0'
4+
__version__ = '7.2.0'
55
__author__ = 'Elastic'
66
__author_email__ = 'support@elastic.co'

0 commit comments

Comments
 (0)