Skip to content

Commit 5ac5ea4

Browse files
fix readme note formatting
1 parent f2d41bb commit 5ac5ea4

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

README

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,27 @@
11
Elasticsearch DSL
22
=================
33

4-
> [!NOTE]
5-
> As of release 9.0, Elasticsearch DSL is part of the official Elasticsearch
6-
> client for Python, so a separate install is not needed. To migrate, just
7-
> replace `elasticsearch_dsl` with `elasticsearch.dsl` in all imports.
8-
>
9-
> The following instructions apply to versions 8 and older.
4+
Deprecation notice
5+
------------------
6+
7+
As of release 8.18.0, the Elasticsearch DSL package is part of the official
8+
`Elasticsearch Python client <https://github.com/elastic/elasticsearch-py>`_,
9+
so a separate install is not needed anymore. To migrate, follow these steps:
10+
11+
- Uninstall the ``elasticsearch-dsl`` package
12+
- Make sure you have version 8.18.0 or newer of the ``elasticsearch`` package
13+
installed
14+
- Replace ``elasticsearch_dsl`` with ``elasticsearch.dsl`` in your imports
15+
16+
To prevent applications from breaking unexpectedly due to this change, the
17+
8.18.0 release of this package automatically redirects all imports to the
18+
corresponding modules of the Python client package.
19+
20+
The following instructions only apply to versions 8.17 and older of this
21+
package.
22+
23+
Introduction
24+
------------
1025

1126
Elasticsearch DSL is a high-level library whose aim is to help with writing and
1227
running queries against Elasticsearch. It is built on top of the official

0 commit comments

Comments
 (0)