README.md
1python-rrdtool
2==============
3
4Python bindings for [RRDtool](https://oss.oetiker.ch/rrdtool) with a native C extension.
5
6Supported Python versions: 2.6+, 3.3+.
7
8The bindings are based on the code of the original Python 2 bindings for rrdtool by Hye-Shik Chang, which are currently shipped as official bindings with rrdtool.
9
10Installation
11------------
12
13The easy way:
14
15 # pip install rrdtool
16
17**Note:** This requires rrdtool and it's development files (headers, libraries, dependencies) to be installed.
18
19In case you'd like to build the module on your own, you can obtain a copy of the repository and run `python setup.py install` in it's destination folder to build the native C extension.
20
21Usage
22-----
23
24```python
25import rrdtool
26
27# Create Round Robin Database
28rrdtool.create('test.rrd', '--start', 'now', '--step', '300', 'RRA:AVERAGE:0.5:1:1200', 'DS:temp:GAUGE:600:-273:5000')
29
30# Feed updates to the RRD
31rrdtool.update('test.rrd', 'N:32')
32```
33
34Documentation
35-------------
36
37You can find the latest documentation for this project at http://pythonhosted.org/rrdtool.