aboutsummaryrefslogtreecommitdiffstats
path: root/src/python/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/python/README.md')
-rw-r--r--src/python/README.md17
1 files changed, 17 insertions, 0 deletions
diff --git a/src/python/README.md b/src/python/README.md
new file mode 100644
index 0000000..90906c6
--- /dev/null
+++ b/src/python/README.md
@@ -0,0 +1,17 @@
+# Netconf Server Python Application
+This application is providing core Netconf Server capabilities.
+It is started in detached mode on image startup.
+
+Application capabilities:
+ - Subscribing on config change per model.
+ - Models to subscribe to are loaded from configuration file,
+ provided as application parameter.
+ - When configuration of one of models change
+ information about change are logged
+
+
+## Testing
+Tox file with pytest are used fo testing.
+
+## Logging
+Application prints logs on to the console and to file `/logs/netconf_saver.log`