summaryrefslogtreecommitdiffstats
path: root/docs/plugins/crypter_plugin.rst
diff options
context:
space:
mode:
authorGravatar RaNaN <Mast3rRaNaN@hotmail.de> 2012-02-05 17:27:13 +0100
committerGravatar RaNaN <Mast3rRaNaN@hotmail.de> 2012-02-05 17:27:13 +0100
commitda4cf026ad116518fefc3429b74a8cd94aeef73f (patch)
treef555fde96747f27ae5fb2f258b0290e368d9d5ee /docs/plugins/crypter_plugin.rst
parentclosed #261 (diff)
downloadpyload-da4cf026ad116518fefc3429b74a8cd94aeef73f.tar.xz
updated documentation + diagrams
Diffstat (limited to 'docs/plugins/crypter_plugin.rst')
-rw-r--r--docs/plugins/crypter_plugin.rst18
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/plugins/crypter_plugin.rst b/docs/plugins/crypter_plugin.rst
index 1497ced07..4e7803808 100644
--- a/docs/plugins/crypter_plugin.rst
+++ b/docs/plugins/crypter_plugin.rst
@@ -19,7 +19,7 @@ target urls and subclass from :class:`Crypter <module.plugins.Crypter.Crypter>`.
return urls
You have to overwrite at least one of ``.decryptFile``, ``.decryptURL``, ``.decryptURLs``. The first one
-is only useful for container files, whereas the last is usefull when it's possible to handle a bunch of urls
+is only useful for container files, whereas the last is useful when it's possible to handle a bunch of urls
at once. If in doubt, just overwrite `decryptURL`.
Generating Packages
@@ -44,8 +44,22 @@ And that's basically all you need to know. Just as little side-note if you want
your code you can use::
plugin = self.core.pluginManager.loadClass("crypter", "NameOfThePlugin")
+ # Core instance is needed for decrypting
# decrypted will be a list of urls
- decrypted = plugin.decrypt(urls)
+ decrypted = plugin.decrypt(core, urls)
+
+
+SimpleCrypter
+-------------
+
+For simple crypter services there is the :class:`SimpleCrypter <module.plugins.internal.SimpleCrypter.SimpleCrypter>` class which handles most of the workflow. Only the regexp
+pattern have to be defined.
+
+Exmaple::
+
+ from module.plugins.internal.SimpleCrypter import SimpleCrypter
+
+ class MyFileCrypter(SimpleCrypter):
Testing
-------