Skip to content

Commit

Permalink
Update compatibility matrix to reflect supported versions
Browse files Browse the repository at this point in the history
  • Loading branch information
sethmlarson committed Aug 4, 2021
1 parent 0312570 commit 93543a7
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 88 deletions.
32 changes: 4 additions & 28 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,35 +36,11 @@ Read more about `how to use asyncio with this project <https://elasticsearch-py.
Compatibility
-------------

The library is compatible with all Elasticsearch versions since ``0.90.x`` but you
**have to use a matching major version**:
Language clients are forward compatible; meaning that clients support communicating
with greater minor versions of Elasticsearch.

For **Elasticsearch 7.0** and later, use the major version 7 (``7.x.y``) of the
library.

For **Elasticsearch 6.0** and later, use the major version 6 (``6.x.y``) of the
library.

For **Elasticsearch 5.0** and later, use the major version 5 (``5.x.y``) of the
library.

For **Elasticsearch 2.0** and later, use the major version 2 (``2.x.y``) of the
library, and so on.

The recommended way to set your requirements in your `setup.py` or
`requirements.txt` is::

# Elasticsearch 7.x
elasticsearch>=7.0.0,<8.0.0

# Elasticsearch 6.x
elasticsearch>=6.0.0,<7.0.0

# Elasticsearch 5.x
elasticsearch>=5.0.0,<6.0.0

# Elasticsearch 2.x
elasticsearch>=2.0.0,<3.0.0
Elastic language clients are also backwards compatible with lesser supported
minor Elasticsearch versions.

If you have a need to have multiple versions installed at the same time older
versions are also released as ``elasticsearch2`` and ``elasticsearch5``.
Expand Down
34 changes: 4 additions & 30 deletions docs/guide/overview.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,37 +10,11 @@ on https://elasticsearch-py.readthedocs.io[Read the Docs].
[discrete]
=== Compatibility

Current development happens in the master branch.
Language clients are forward compatible; meaning that clients support communicating
with greater minor versions of Elasticsearch.

The library is compatible with all Elasticsearch versions since `0.90.x` but you
**have to use a matching major version**:

For **Elasticsearch 7.0** and later, use the major version 7 (`7.x.y`) of the
library.

For **Elasticsearch 6.0** and later, use the major version 6 (`6.x.y`) of the
library.

For **Elasticsearch 5.0** and later, use the major version 5 (`5.x.y`) of the
library.

For **Elasticsearch 2.0** and later, use the major version 2 (`2.x.y`) of the
library, and so on.

The recommended way to set your requirements in your `setup.py` or
`requirements.txt` is::

# Elasticsearch 7.x
elasticsearch>=7,<8

# Elasticsearch 6.x
elasticsearch>=6,<7

# Elasticsearch 5.x
elasticsearch>=5,<6

# Elasticsearch 2.x
elasticsearch>=2,<3
Elastic language clients are also backwards compatible with lesser supported
minor Elasticsearch versions.

If you have a need to have multiple versions installed at the same time older
versions are also released as `elasticsearch2` and `elasticsearch5`.
Expand Down
34 changes: 4 additions & 30 deletions docs/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,37 +29,11 @@ Read more about `how to use asyncio with this project <async.html>`_.
Compatibility
-------------

The library is compatible with all Elasticsearch versions since ``0.90.x`` but you
**have to use a matching major version**:
Language clients are forward compatible; meaning that clients support communicating
with greater minor versions of Elasticsearch.

For **Elasticsearch 7.0** and later, use the major version 7 (``7.x.y``) of the
library.

For **Elasticsearch 6.0** and later, use the major version 6 (``6.x.y``) of the
library.

For **Elasticsearch 5.0** and later, use the major version 5 (``5.x.y``) of the
library.

For **Elasticsearch 2.0** and later, use the major version 2 (``2.x.y``) of the
library, and so on.

The recommended way to set your requirements in your `setup.py` or
`requirements.txt` is:

.. code-block:: python
# Elasticsearch 7.x
elasticsearch>=7.0.0,<8.0.0
# Elasticsearch 6.x
elasticsearch>=6.0.0,<7.0.0
# Elasticsearch 5.x
elasticsearch>=5.0.0,<6.0.0
# Elasticsearch 2.x
elasticsearch>=2.0.0,<3.0.0
Elastic language clients are also backwards compatible with lesser supported
minor Elasticsearch versions.

If you have a need to have multiple versions installed at the same time older
versions are also released as ``elasticsearch2``, ``elasticsearch5`` and ``elasticsearch6``.
Expand Down

0 comments on commit 93543a7

Please sign in to comment.