summaryrefslogtreecommitdiffstats
path: root/python/traitlets/README
diff options
context:
space:
mode:
Diffstat (limited to 'python/traitlets/README')
-rw-r--r--python/traitlets/README12
1 files changed, 12 insertions, 0 deletions
diff --git a/python/traitlets/README b/python/traitlets/README
new file mode 100644
index 0000000000..67b73cc20d
--- /dev/null
+++ b/python/traitlets/README
@@ -0,0 +1,12 @@
+Traitlets is a pure Python library enabling:
+
+* the enforcement of strong typing for attributes of Python objects (typed
+ attributes are called "traits")
+* notifications on changes of trait attributes
+* automatic validation and coercion of trait attributes when attempting a
+ change
+
+Its implementation relies on the descriptor pattern.
+
+Traitlets powers the configuration system of IPython and Jupyter and the
+declarative API of IPython interactive widgets.