summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorEli Collins <elic@assurancetechnologies.com>2016-06-10 12:32:52 -0400
committerEli Collins <elic@assurancetechnologies.com>2016-06-10 12:32:52 -0400
commit281dacd121d72c7570442a13f2113f63c6c439ba (patch)
tree997fcabde572da2fc5c8158243e26cce64ee3874 /README
parent61dc39910c6904c69f2e81d5dd41090cac1f18a1 (diff)
downloadpasslib-281dacd121d72c7570442a13f2113f63c6c439ba.tar.gz
.encrypt() method renamed to .hash(), other api cleanups
.encrypt() ---------- hash.encrypt() & context.encrypt() have been renamed to .hash(). this should take care of the long-standing issue 21 (the poor naming of .encrypt). per docs, legacy aliases will remain in place until passlib 2.0. .genhash() / .genconfig() ------------------------- taking advantage of this reorganization to also deprecate .genconfig() and .genhash() -- they're not really useful in a modern system, nor as needed for historical support as initially thought: .genconfig() will be retired completely in passlib 2.0; .genhash() is rolled into the new .hash() method along with .encrypt().
Diffstat (limited to 'README')
-rw-r--r--README2
1 files changed, 1 insertions, 1 deletions
diff --git a/README b/README
index e7e9c15..174bc45 100644
--- a/README
+++ b/README
@@ -34,7 +34,7 @@ A quick example of using passlib to integrate into a new application::
>>> from passlib.apps import custom_app_context as pwd_context
>>> # encrypting a password...
- >>> hash = pwd_context.encrypt("somepass")
+ >>> hash = pwd_context.hash("somepass")
>>> hash
'$6$rounds=36122$kzMjVFTjgSVuPoS.$zx2RoZ2TYRHoKn71Y60MFmyqNPxbNnTZdwYD8y2atgoRIp923WJSbcbQc6Af3osdW96MRfwb5Hk7FymOM6D7J1'