Information about python2 support in readme. Fixed formatting.
paulfantom committed
Jun 20, 2016 at 09:22 UTC
58b1c3b11cc29f426bf01b1830034cea324e080f
1 file changed
+8
-3
python.d/README.md
+8
-3
@@ -2,12 +2,14 @@
2
3
**Python plugin support is experimental and implementation may change in the future**
4
5
-Currently every plugin must be written in python3.
5
+Every plugin should be compatible with python2 and python3.
6
All third party libraries should be installed system-wide or in `python_modules` directory.
7
Module configurations are written in YAML and **pyYAML is required**.
8
9
Every configuration file must have one of two formats:
10
-1. Configuration for only one job:
10
+
11
+- Configuration for only one job:
12
+
13
```yaml
14
update_every : 2 # update frequency
15
retries : 1 # how many failures in update() is tolerated
@@ -16,7 +18,9 @@ priority : 20000 # where it is shown on dashboard
18
other_var1 : bla # variables passed to module
19
other_var2 : alb
20
```
19
-2. Configuration for many jobs (ex. mysql):
21
+
22
+- Configuration for many jobs (ex. mysql):
23
+
24
```yaml
25
# module defaults:
26
update_every : 2
@@ -35,6 +39,7 @@ other_job:
39
```
40
41
`update_every`, `retries`, and `priority` are always optional.
42
+
43
---
44
45
The following python.d plugins are supported: