.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "RRDPYTHON 1"
.TH RRDPYTHON 1 2026-08-08 1.11.0 rrdtool
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
rrdpython \- About the RRD Python bindings
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\& import rrdtool
\& rrdtool.create(\*(Aq/tmp/test.rrd\*(Aq, \*(AqDS:foo:GAUGE:20:0:U\*(Aq)
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \fBrrdtool\fR functions are directly callable via the Python programming
language. This wrapper implementation has been written from the scratch
(without  SWIG)
.PP
The API expects strings and/or a list of strings as parameters to the functions.
Please refer to the other \fBrrdtool\fR documentation for functions and valid arguments.
.SH EXAMPLES
.IX Header "EXAMPLES"
.SS "Example 1"
.IX Subsection "Example 1"
.Vb 3
\& import sys
\& sys.path.append(\*(Aq/path/to/rrdtool/lib/python2.6/site\-packages/\*(Aq)
\& import rrdtool, tempfile
\&
\& DAY = 86400
\& YEAR = 365 * DAY
\& fd,path = tempfile.mkstemp(\*(Aq.png\*(Aq)
\&
\& rrdtool.graph(path,
\&              \*(Aq\-\-imgformat\*(Aq, \*(AqPNG\*(Aq,
\&              \*(Aq\-\-width\*(Aq, \*(Aq540\*(Aq,
\&              \*(Aq\-\-height\*(Aq, \*(Aq100\*(Aq,
\&              \*(Aq\-\-start\*(Aq, "\-%i" % YEAR,
\&              \*(Aq\-\-end\*(Aq, "\-1",
\&              \*(Aq\-\-vertical\-label\*(Aq, \*(AqDownloads/Day\*(Aq,
\&              \*(Aq\-\-title\*(Aq, \*(AqAnnual downloads\*(Aq,
\&              \*(Aq\-\-lower\-limit\*(Aq, \*(Aq0\*(Aq,
\&              \*(AqDEF:downloads=downloads.rrd:downloads:AVERAGE\*(Aq,
\&              \*(AqAREA:downloads#990033:Downloads\*(Aq)
\&
\& info = rrdtool.info(\*(Aqdownloads.rrd\*(Aq)
\& print info[\*(Aqlast_update\*(Aq]
\& print info[\*(Aqds[downloads].minimal_heartbeat\*(Aq]
.Ve
.SS "Example 2"
.IX Subsection "Example 2"
.Vb 3
\& import sys
\& sys.path.append(\*(Aq/path/to/rrdtool/lib/python2.6/site\-packages/\*(Aq)
\& import rrdtool
\&
\& # in real life data_sources would be populated in loop or something similar
\& data_sources=[ \*(AqDS:speed1:COUNTER:600:U:U\*(Aq,
\&                \*(AqDS:speed2:COUNTER:600:U:U\*(Aq,
\&                \*(AqDS:speed3:COUNTER:600:U:U\*(Aq ]
\&
\& rrdtool.create( \*(Aqspeed.rrd\*(Aq,
\&                 \*(Aq\-\-start\*(Aq, \*(Aq920804400\*(Aq,
\&                 data_sources,
\&                 \*(AqRRA:AVERAGE:0.5:1:24\*(Aq,
\&                 \*(AqRRA:AVERAGE:0.5:6:10\*(Aq )
.Ve
.PP
If you use the \fBsite\-python\-install\fR make target you can drop to first sys.path.append
line since the RRDtool module will be available everywhere.
.PP
If RRDtool runs into trouble, it will throw an exception which you might want to catch.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
rrdcreate, rrdupdate, rrdgraph, rrddump, rrdfetch, rrdtune, rrdlast,
rrdxport, rrdinfo
.SH AUTHOR
.IX Header "AUTHOR"
Hye\-Shik Chang <perky@i18n.org>
.PP
Alan Milligan <alan.milligan@last\-bastion.net>