Skip to content

Commit 66e1ea1

Browse files
authored
[DOCS] Restructures repo readme (#2256)
1 parent 08da486 commit 66e1ea1

File tree

1 file changed

+17
-39
lines changed

1 file changed

+17
-39
lines changed

README.rst

Lines changed: 17 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,27 @@ Features
4242
Installation
4343
------------
4444

45-
Install the ``elasticsearch`` package with `pip
46-
<https://pypi.org/project/elasticsearch>`_::
45+
Refer to the `Installation section <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_installation>`_
46+
of the getting started documentation.
4747

48-
$ python -m pip install elasticsearch
4948

50-
If your application uses async/await in Python you can install with
51-
the ``async`` extra::
49+
Connecting
50+
----------
5251

53-
$ python -m pip install elasticsearch[async]
52+
Refer to the `Connecting section <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_connecting>`_
53+
of the getting started documentation.
5454

55-
Read more about `how to use asyncio with this project <https://elasticsearch-py.readthedocs.io/en/latest/async.html>`_.
55+
56+
Usage
57+
-----
58+
59+
* `Creating an index <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_creating_an_index>`_
60+
* `Indexing a document <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_indexing_documents>`_
61+
* `Getting documents <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_getting_documents>`_
62+
* `Searching documents <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_searching_documents>`_
63+
* `Updating documents <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_updating_documents>`_
64+
* `Deleting documents <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_deleting_documents>`_
65+
* `Deleting an index <https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/getting-started-python.html#_deleting_an_index>`_
5666

5767

5868
Compatibility
@@ -74,38 +84,6 @@ Documentation for the client is `available on elastic.co`_ and `Read the Docs`_.
7484
.. _available on elastic.co: https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/index.html
7585
.. _Read the Docs: https://elasticsearch-py.readthedocs.io
7686

77-
Quick Start
78-
-----------
79-
80-
.. code-block:: python
81-
82-
# Import the client from the 'elasticsearch' module
83-
>>> from elasticsearch import Elasticsearch
84-
85-
# Instantiate a client instance
86-
>>> client = Elasticsearch("http://localhost:9200")
87-
88-
# Call an API, in this example `info()`
89-
>>> resp = client.info()
90-
91-
# View the result
92-
>>> resp
93-
{
94-
"name" : "instance-name",
95-
"cluster_name" : "cluster-name",
96-
"cluster_uuid" : "cluster-uuid",
97-
"version" : {
98-
"number" : "7.14.0",
99-
...
100-
},
101-
"tagline" : "You know, for Search"
102-
}
103-
104-
105-
You can read more about `configuring the client`_ in the documentation.
106-
107-
.. _configuring the client: https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/connecting.html
108-
10987

11088
License
11189
-------

0 commit comments

Comments
 (0)