* Added support for Python 2.7 (other 2.x versions might also work, but its not tested)

[people/ms/python-rrdtool.git] / README.md

diff --git a/README.md b/README.md
index 3492a0bd17772430c6da11fcd3ee7608f732a807..8afd59d4e43967b1f17574c43c233af27f486670 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-rrdtool-py3k
-============
+python-rrdtool
+==============
 
-Python 3 bindings for rrdtool with a native C extension and an object-oriented way to work with Round Robin Databases.
+Python bindings for rrdtool with a native C extension and an object-oriented way to work with Round Robin Databases. As of version 0.1.1, Python 2 and 3 is supported.
 
 The bindings are based on the code of the original Python 2 bindings for rrdtool by Hye-Shik Chang.
 
@@ -10,7 +10,7 @@ Installation
 
 In order to build the native C extension (which is an required step), you'll need librrd and its headers installed. Having rrdtool installed should be enough on most distributions.
 
-**How to Install? **
+**How to Install?**
 
 1. Download a copy of the repository.
 2. Run `python setup.py install` to build an install the native C extension as well as the RRD module.
@@ -20,8 +20,6 @@ Usage
 
 You can either use the low-level `rrdtool` module (which offers almost the same functions as the old Python 2 bindings for rrdtool provided), or the `RRDtool` module, which represents a object-oriented interface to rrdtool.
 
-Unlike the Python 2 binding, this binding is able to create graphs entirely in-memory, which makes it ideal for generating a large amount of graphs without having high I/O. This feature is currently available on POSIX platforms only, because I wasn't able to find a portable way to redirect stdout to a memory allocated buffer (which is required for that). To use this feature, specify "-" as the output filename in graphs (low-level extension), or `None` in the high-level module.
-
 ### Using the low-level `rrdtool` module
 
 ```python
@@ -49,13 +47,34 @@ rrd.update([(None, 32)])
 rrd.graph('test.png', '--end', 'now', '--start', 'end-5minutes', '--width', '400', 'DEF:ds0a=test.rrd:temp:AVERAGE', 'LINE1:ds0a#0000FF:"temperature\l"')
 
 # Same, but keep data in memory.
-data = rrd.graph(None, '--end', 'now', '--start', 'end-5minutes', '--width', '400', 'DEF:ds0a=test.rrd:temp:AVERAGE', 'LINE1:ds0a#0000FF:"temperature\l"')
+imgdata = rrd.graph(None, '--end', 'now', '--start', 'end-5minutes', '--width', '400', 'DEF:ds0a=test.rrd:temp:AVERAGE', 'LINE1:ds0a#0000FF:"temperature\l"')
 
 # You can also use file-like objects
 from io import BytesIO
 rrd.graph(io, ...)
 ```
 
+Changes
+-------
+
+## 0.1.1
+
+*Released 2013-12-19*
+
+* Added support for Python 2.7 (other 2.x versions might also work, but its not tested)
+* Added dump command
+* Fixed some issues regarding generating graphs with `graphv` on Python 3.3
+
+*Please note:* The `graph` method in the object-oriented RRD class will now return a dict by default (as returned by graphv). Only if the `output_file` parameter is None, the actual graph image bytes are returned. Python 3.3 will return a bytes object whereas Python 2.x will return a str object.
+
+## 0.1.0
+
+*Released 2012-09-17*
+
+* Initial release.
+* Support for Python 3.x added
+* Updated documentation strings (`__doc__`) for each of the rrdtool functions
+
 Author
 ------