From 6b0c2d2c4c0af274743f12ee523703d624529383 Mon Sep 17 00:00:00 2001
From: Jordan Wiens <jordan@psifertex.com>
Date: Wed, 28 Aug 2019 08:07:18 -0400
Subject: add transform documentation

---
 python/transform.py | 11 +++++++++++
 1 file changed, 11 insertions(+)

(limited to 'python/transform.py')

diff --git a/python/transform.py b/python/transform.py
index 6d72f3cc..01d9e9ab 100644
--- a/python/transform.py
+++ b/python/transform.py
@@ -116,6 +116,17 @@ class TransformParameter(object):
 
 
 class Transform(with_metaclass(_TransformMetaClass, object)):
+	"""
+	``class Transform`` is an implementation of the TransformMetaClass that implements custom transformations. New 
+	transformations may be added at runtime, so an instance of a transform is created like::
+
+		>>> list(Transform)
+		[<transform: Zlib>, <transform: StringEscape>, <transform: RawHex>, <transform: HexDump>, <transform: Base64>, <transform: Reverse>, <transform: CArray08>, <transform: CArrayA16>, <transform: CArrayA32>, <transform: CArrayA64>, <transform: CArrayB16>, <transform: CArrayB32>, <transform: CArrayB64>, <transform: IntList08>, <transform: IntListA16>, <transform: IntListA32>, <transform: IntListA64>, <transform: IntListB16>, <transform: IntListB32>, <transform: IntListB64>, <transform: MD4>, <transform: MD5>, <transform: SHA1>, <transform: SHA224>, <transform: SHA256>, <transform: SHA384>, <transform: SHA512>, <transform: AES-128 ECB>, <transform: AES-128 CBC>, <transform: AES-256 ECB>, <transform: AES-256 CBC>, <transform: DES ECB>, <transform: DES CBC>, <transform: Triple DES ECB>, <transform: Triple DES CBC>, <transform: RC2 ECB>, <transform: RC2 CBC>, <transform: Blowfish ECB>, <transform: Blowfish CBC>, <transform: CAST ECB>, <transform: CAST CBC>, <transform: RC4>, <transform: XOR>]
+		>>> sha512=Transform['SHA512']
+		>>> rawhex=Transform['RawHex']
+		>>> rawhex.encode(sha512.encode("test string"))
+		'10e6d647af44624442f388c2c14a787ff8b17e6165b83d767ec047768d8cbcb71a1a3226e7cc7816bc79c0427d94a9da688c41a3992c7bf5e4d7cc3e0be5dbac'
+	"""
 	transform_type = None
 	name = None
 	long_name = None
-- 
cgit v1.3.1