Documentation for DataFrameClient

timtroendle · timtroendle · commit bd930bd2fe20 · 2014-11-22T03:00:07.000+01:00
diff --git a/README.rst b/README.rst
@@ -52,15 +52,16 @@ On Debian/Ubuntu, you can install it with this command::
 Dependencies
 ============
 
-The InfluxDB-Python distribution is supported and tested on Python 2.7 and Python 3.3.
+The InfluxDB-Python distribution is supported and tested on Python 2.7 and Python 3.4.
 
-Main dependencie is:
+Main dependency is:
 
 - Requests: HTTP library for human beings (http://docs.python-requests.org/)
 
 
 Additional dependencies are:
 
+- pandas: for writing from and reading to DataFrames (http://pandas.pydata.org/)
 - Sphinx: Tool to create and manage the documentation (http://sphinx-doc.org/)
 - Nose: to auto-discover tests (http://nose.readthedocs.org/en/latest/)
 - Mock: to mock tests (https://pypi.python.org/pypi/mock)
diff --git a/docs/source/api-documentation.rst b/docs/source/api-documentation.rst
@@ -20,9 +20,17 @@ ports. The below instantiation statements are all equivalent::
     # using UDP
     client = InfluxDBClient(host='127.0.0.1', dbname='dbname', use_udp=True, udp_port=4444)
 
+To write pandas DataFrames or to read data into a
+pandas DataFrame, use a :py:class:`~influxdb.misc.DataFrameClient` object.
+These clients are initiated in the same way as the
+:py:class:`~influxdb.InfluxDBClient`::
+
+    from influxdb.misc import DataFrameClient
+
+    client = DataFrameClient(host='127.0.0.1', port=8086, username='root', password='root', dbname='dbname')
 
-.. note:: Only when using UDP (use_udp=True) the connections is established.
 
+.. note:: Only when using UDP (use_udp=True) the connections is established.
 
 
 .. _InfluxDBClient-api:
@@ -36,3 +44,13 @@ ports. The below instantiation statements are all equivalent::
 .. autoclass:: influxdb.InfluxDBClient
     :members:
     :undoc-members:
+
+-----------------------
+:class:`DataFrameClient`
+-----------------------
+
+
+.. currentmodule:: influxdb.misc.DataFrameClient
+.. autoclass:: influxdb.misc.DataFrameClient
+    :members:
+    :undoc-members:
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -13,3 +13,10 @@ Tutorials - Basic
 .. literalinclude:: ../../examples/tutorial.py
    :language: python
    :linenos:
+
+Tutorials - pandas
+==================
+
+.. literalinclude:: ../../examples/tutorial_pandas.py
+   :language: python
+   :linenos:
