Added examples.

Author: gorgitko

Diff for: examples/example_01.py

@@ -0,0 +1,15 @@
+# basic operations
+
+from valve_keyvalues_python.keyvalues import KeyValues
+
+filename_vdf = "example_01.vdf"
+
+kv = KeyValues(filename=filename_vdf)
+print(kv)
+# dump only one part
+print(kv.dump(mapper=kv["second"]))
+
+kv["second"]["second_fourth"] = "second_fourth value"
+kv["second"]["second_first"] = "I don't like this notation."
+del kv["third"]
+print(kv)

Diff for: examples/example_01.vdf

@@ -0,0 +1,11 @@
+"first" "first value"
+"second"
+{
+    "second_first"  "second_first value"
+    "second_second"
+    {
+        "second_second_first"   "second_second_first value"
+    }
+    "second_third"  "second_third value"
+}
+"third" "third value"

Diff for: examples/example_02.py

@@ -0,0 +1,15 @@
+# using the optional functions
+
+from valve_keyvalues_python.keyvalues import KeyValues
+
+filename_vdf = "example_02.vdf"
+
+kv = KeyValues(filename=filename_vdf, key_modifier=str.upper, key_sorter=sorted)
+
+# all keys modified to uppercase, key sorted alphabetically
+print(kv)
+
+kv["AAA"] = "I want to be first."
+print(kv.dump())
+
+print(print(kv) == print(kv.dump()))

Diff for: examples/example_02.vdf

@@ -0,0 +1,12 @@
+"zZzZ" "I want to be the last."
+"second"
+{
+    "second_first"  "second_first value"
+    "second_THIRD"  "second_third value"
+    "SECOND_second"
+    {
+        "second_second_first"   "second_second_first value"
+    }
+}
+"First" "first value"
+"Third" "third value"

Diff for: examples/example_03.py

@@ -0,0 +1,25 @@
+# "advanced" uses
+
+from valve_keyvalues_python.keyvalues import KeyValues
+
+filename_vdf = "example_02.vdf"
+
+def key_modifier(key):
+    return key.lower() + "_modified"
+
+def reverse_sorter(keys):
+    return sorted(keys, reverse=True)
+
+kv = KeyValues()
+kv.parse(filename_vdf)
+print(kv)
+
+# modify the keys
+kv.parse(filename_vdf, key_modifier=key_modifier)
+print(kv)
+
+# print sorted alphabetically descending
+print(kv.dump(key_sorter=reverse_sorter))
+
+# print keys reversed
+print(kv.dump(key_sorter=reversed))

Diff for: examples/example_03.vdf

@@ -0,0 +1,12 @@
+"zZzZ" "I want to be the last."
+"second"
+{
+    "second_THIRD"  "second_third value"
+    "SECOND_second"
+    {
+        "second_second_first"   "second_second_first value"
+    }
+    "second_first"  "second_first value"
+}
+"Third" "third value"
+"First" "first value"