From 9b1205b30b37e1ef53666a1a1d51b573259becdf Mon Sep 17 00:00:00 2001 From: oetiker Date: Wed, 11 May 2005 18:31:00 +0000 Subject: [PATCH] intial python bindings documentation git-svn-id: svn://svn.oetiker.ch/rrdtool/branches/1.2/program@543 a5681a0c-68f1-0310-ab6d-d61299d08faa --- doc/rrdpython.pod | 53 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 doc/rrdpython.pod diff --git a/doc/rrdpython.pod b/doc/rrdpython.pod new file mode 100644 index 0000000..a158577 --- /dev/null +++ b/doc/rrdpython.pod @@ -0,0 +1,53 @@ +=head1 NAME + +rrdpython - About the RRD Python bindings + +=head1 SYNOPSIS + + import rrdtool + rrdtool.create('/tmp/test.rrd', 'DS:foo:GUAGE:20:0:U') + +=head1 DESCRIPTION + +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. + +=head1 EXAMPLE + + import rrdtool, tempfile + + DAY = 86400 + YEAR = 365 * DAY + fd,path = tempfile.mkstemp('.png') + + rrdtool.graph(path, + '--imgformat', 'PNG', + '--width', '540', + '--height', '100', + '--start', "-%i" % YEAR, + '--end', "-1", + '--vertical-label', 'Downloads/Day', + '--title', 'Annual downloads', + '--lower-limit', '0', + 'DEF:downloads=downloads.rrd:downloads:AVERAGE', + 'AREA:downloads#990033:Downloads') + + info = rrdtool.info('downloads.rrd') + print info['last_update'] + print info['ds']['downloads']['minimal_heartbeat'] + +=head1 SEE ALSO + +rrdcreate, rrdupdate, rrdgraph, rrddump, rrdfetch, rrdtune, rrdlast, +rrdxport, rrdinfo + +=head1 AUTHOR + +Hye-Shik Chang Eperky@i18n.orgE + +Alan Milligan Ealan.milligan@last-bastion.netE + -- 2.30.2