X-Git-Url: https://git.octo.it/?a=blobdiff_plain;f=doc%2Frrdpython.pod;h=ba21f1608ddf0ee3c112aed211b87b4a85da6203;hb=6a36cc27733ba7908809cfc43c2cdd0ce49178e0;hp=f041b0b59b0eed011bb592a1c6d48f3de0cf9879;hpb=e9168ed5a5d59bc19dbd80ed0f96be344a630e6e;p=rrdtool.git diff --git a/doc/rrdpython.pod b/doc/rrdpython.pod index f041b0b..ba21f16 100644 --- a/doc/rrdpython.pod +++ b/doc/rrdpython.pod @@ -13,13 +13,15 @@ The B functions are directly callable via the Python programming language. This wrapper implementation has been written from the scratch (without SWIG) -The API's simply expects string parameters to the functions. Please refer -to the other B documentation for functions and valid arguments. +The API's expects strings and/or list of strings as parameters to the functions. +Please refer to the other B documentation for functions and valid arguments. -=head1 EXAMPLE +=head1 EXAMPLES + +=head2 Example 1 import sys - sys.path.append('/path/to/rrdtool/lib/python2.3/site-packages/') + sys.path.append('/path/to/rrdtool/lib/python2.6/site-packages/') import rrdtool, tempfile DAY = 86400 @@ -40,12 +42,29 @@ to the other B documentation for functions and valid arguments. info = rrdtool.info('downloads.rrd') print info['last_update'] - print info['ds']['downloads']['minimal_heartbeat'] + print info['ds[downloads].minimal_heartbeat'] + +=head2 Example 2 + + import sys + sys.path.append('/path/to/rrdtool/lib/python2.6/site-packages/') + import rrdtool + + # in real life data_sources would be populated in loop or something similar + data_sources=[ 'DS:speed1:COUNTER:600:U:U', + 'DS:speed2:COUNTER:600:U:U', + 'DS:speed3:COUNTER:600:U:U' ] + + rrdtool.create( 'speed.rrd', + '--start', '920804400', + data_sources, + 'RRA:AVERAGE:0.5:1:24', + 'RRA:AVERAGE:0.5:6:10' ) If you use the B make target you can drop to first sys.path.append -line since the rrdtool module will be available everywhere. +line since the RRDtool module will be available everywhere. -If rrdtool runs into trouble, it will throw an exception which you might want to catch. +If RRDtool runs into trouble, it will throw an exception which you might want to catch. =head1 SEE ALSO @@ -57,4 +76,3 @@ rrdxport, rrdinfo Hye-Shik Chang Eperky@i18n.orgE Alan Milligan Ealan.milligan@last-bastion.netE -