Browse Source

[docs] Updating the Python client docxs

Honza Král 10 years ago
parent
commit
02798951ef
2 changed files with 41 additions and 7 deletions
  1. 0 3
      docs/community-clients/index.asciidoc
  2. 41 4
      docs/python/index.asciidoc

+ 0 - 3
docs/community-clients/index.asciidoc

@@ -144,9 +144,6 @@ Also see the {client}/php-api/current/index.html[official Elasticsearch PHP clie
 
 Also see the {client}/python-api/current/index.html[official Elasticsearch Python client].
 
-* http://github.com/elasticsearch/elasticsearch-dsl-py[elasticsearch-dsl-py]
-  chainable query and filter construction built on top of official client.
-
 * http://github.com/rhec/pyelasticsearch[pyelasticsearch]:
   Python client.
 

+ 41 - 4
docs/python/index.asciidoc

@@ -7,7 +7,29 @@ ground for all Elasticsearch-related code in Python; because of this it tries
 to be opinion-free and very extendable. The full documentation is available at
 http://elasticsearch-py.rtfd.org/
 
-It can be installed with:
+.Elasticsearch DSL
+************************************************************************************
+For a more high level client library with more limited scope, have a look at
+http://elasticsearch-dsl.rtfd.org/[elasticsearch-dsl] - a more pythonic library
+sitting on top of `elasticsearch-py`.
+
+It provides a more convenient and idiomatic way to write and manipulate
+http://elasticsearch-dsl.readthedocs.org/en/latest/search_dsl.html[queries]. It
+stays close to the Elasticsearch JSON DSL, mirroring its terminology and
+structure while exposing the whole range of the DSL from Python either directly
+using defined classes or a queryset-like expressions.
+
+It also provides an optional
+http://elasticsearch-dsl.readthedocs.org/en/latest/persistence.html#doctype[persistence
+layer] for working with documents as Python objects in an ORM-like fashion:
+defining mappings, retrieving and saving documents, wrapping the document data
+in user-defined classes.
+************************************************************************************
+
+
+=== Installation
+
+It can be installed with pip:
 
 [source,sh]
 ------------------------------------
@@ -16,13 +38,24 @@ pip install elasticsearch
 
 === Versioning
 
-There are two branches for development - `master` and `0.4`. Master branch is
-used to track all the changes for Elasticsearch 1.0 and beyond whereas 0.4
-tracks Elasticsearch 0.90.
+There are two branches for development - `master` and `1.x`. Master branch is
+used to track all the changes for Elasticsearch 2.0 and beyond whereas 1.x
+tracks Elasticsearch 1.*.
 
 Releases with major version 1 (1.X.Y) are to be used with Elasticsearch 1.* and
 later, 0.4 releases are meant to work with Elasticsearch 0.90.*.
 
+The recommended way to set your requirements in your `setup.py` or
+`requirements.txt` is:
+
+------------------------------------
+    # Elasticsearch 2.x
+    elasticsearch>=2.0.0,<3.0.0
+
+    # Elasticsearch 1.x
+    elasticsearch>=1.0.0,<2.0.0
+------------------------------------
+
 === Example use
 
 Simple use-case:
@@ -71,6 +104,10 @@ The client's features include:
 
 * pluggable architecture
 
+The client also contains a convenient set of
+http://elasticsearch-py.readthedocs.org/en/master/helpers.html[helpers] for
+some of the more engaging tasks like bulk indexing and reindexing.
+
 
 === License