Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

updated gitignore, some more documentation

  • Loading branch information...
commit 2b2b8c00d96702d1d2c1428ff4e5c58ab3e3567a 1 parent 33f4ae7
@eriky authored
Showing with 46 additions and 3 deletions.
  1. +24 −1 .gitignore
  2. +13 −1 doc/Documentation.rst
  3. +9 −1 doc/documentation.html
View
25 .gitignore
@@ -1,10 +1,33 @@
# Project specific
-*.pyc
+*.py[co]
dist
MANIFEST
build
TODO
+# Packages
+*.egg
+*.egg-info
+dist
+build
+eggs
+parts
+bin
+var
+sdist
+develop-eggs
+.installed.cfg
+
+# # Installer logs
+ pip-log.txt
+
+# Unit test / coverage reports
+ .coverage
+ .tox
+
+# #Translations
+ *.mo
+#
# OS or Editor folders
.DS_Store
Thumbs.db
View
14 doc/Documentation.rst
@@ -45,4 +45,16 @@ At the prompt, enter:
You can read the documentation that comes with the esclient code by entering:
-``>>> help(esclient)``
+``>>> help(esclient)``
+
+This should be basic stuff for the average Python programmer though. So let
+us really dive into ESClient now.
+You first need to create an ESClient object, like so:
+
+``>>> es = esclient.ESClient()```
+
+ESClient will by default use localhost as the hostname in combination with
+the default port 9200. You can supply an alternative location for ElasticSearch
+like so:
+
+``>>> es = esclient.ESClient(es_url='http://<hostname>:<port>')``
View
10 doc/documentation.html
@@ -164,7 +164,7 @@ <h1 class="title">ESClient usage</h1>
you prefer.</p>
<p>E.g. with easy_install you'd enter:</p>
<p><tt class="docutils literal"><span class="pre">sudo</span> <span class="pre">easy_install</span> <span class="pre">esclient</span></tt></p>
-<p>Alternatively you may also download ESClient from its <a class="reference" href="https://www.github.com/eriky/ESClient">Github</a> site. After
+<p>Alternatively you may also download ESClient from its <a class="reference" href="https://github.com/eriky/ESClient">Github</a> site. After
unpacking, you can install ESClient with:</p>
<p><tt class="docutils literal"><span class="pre">sudo</span> <span class="pre">python</span> <span class="pre">setup.py</span> <span class="pre">install</span></tt></p>
</div>
@@ -178,6 +178,14 @@ <h1 class="title">ESClient usage</h1>
<p><tt class="docutils literal"><span class="pre">&gt;&gt;&gt;</span> <span class="pre">import</span> <span class="pre">esclient</span></tt></p>
<p>You can read the documentation that comes with the esclient code by entering:</p>
<p><tt class="docutils literal"><span class="pre">&gt;&gt;&gt;</span> <span class="pre">help(esclient)</span></tt></p>
+<p>This should be basic stuff for the average Python programmer though. So let
+us really dive into ESClient now.</p>
+<p>You first need to create an ESClient object, like so:</p>
+<p><tt class="docutils literal"><span class="pre">&gt;&gt;&gt;</span> <span class="pre">es</span> <span class="pre">=</span> <span class="pre">esclient.ESClient()`</span></tt></p>
+<p>ESClient will by default use localhost as the hostname in combination with
+the default port 9200. You can supply an alternative location for ElasticSearch
+like so:</p>
+<p><tt class="docutils literal"><span class="pre">&gt;&gt;&gt;</span> <span class="pre">es</span> <span class="pre">=</span> <span class="pre">esclient.ESClient(es_url='http://&lt;hostname&gt;:&lt;port&gt;')</span></tt></p>
</div>
</div>
</body>
Please sign in to comment.
Something went wrong with that request. Please try again.