This instance was upgraded to Heptapod 0.20.1 today

Commit bd8aa5be authored by Eli Collins's avatar Eli Collins

updated README file

--HG--
branch : stable
parent d1e25c520b43
......@@ -12,28 +12,54 @@ as a framework for managing existing password hashes. It's designed to be useful
for a wide range of tasks, from verifying a hash found in /etc/shadow, to
providing full-strength password hashing for multi-user application.
The latest documentation can be found online at `<http://packages.python.org/passlib>`_.
* See the `documentation <http://packages.python.org/passlib>`_
for details, installation instructions, and examples.
Requirements
============
* Python 2.5 - 2.7 or Python 3.x
* `bcrypt <https://pypi.python.org/pypi/bcrypt>`_, py-bcrypt, or bcryptor
(optional; required only if bcrypt support is needed)
* M2Crypto (optional; accelerates some PBKDF2-based hashes)
* See the `changelog <http://packages.python.org/passlib/history.html>`_
for a description of what's new in Passlib.
Installation
============
To install from source using ``setup.py``::
* Visit `PyPI <https://pypi.python.org/pypi/passlib>`_
for the latest stable release.
All releases are signed with the gpg key
`4CE1ED31 <http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x4D8592DF4CE1ED31>`_.
python setup.py install
* Additional questions about usage or features? Feel free to post on our
`mailing list <http://groups.google.com/group/passlib-users>`_.
For more detailed installation & testing instructions, see "docs/install.rst"
Usage
=====
A quick example of using passlib to integrate into a new application::
>>> # import the context under an app-specific name (so it can easily be replaced later)
>>> from passlib.apps import custom_app_context as pwd_context
>>> # encrypting a password...
>>> hash = pwd_context.encrypt("somepass")
>>> hash
'$6$rounds=36122$kzMjVFTjgSVuPoS.$zx2RoZ2TYRHoKn71Y60MFmyqNPxbNnTZdwYD8y2atgoRIp923WJSbcbQc6Af3osdW96MRfwb5Hk7FymOM6D7J1'
>>> # verifying a password...
>>> ok = pwd_context.verify("somepass", hash)
True
>>> ok = pwd_context.verify("letmein", hash)
False
For more details and an extended set of examples, see the full documentation;
This example barely touches on the range of features available.
Online Resources
================
* Homepage - https://bitbucket.org/ecollins/passlib
* Docs - http://packages.python.org/passlib
* Discussion - http://groups.google.com/group/passlib-users
* Documentation - http://packages.python.org/passlib
* Mailing list - http://groups.google.com/group/passlib-users
* Downloads - https://pypi.python.org/pypi/passlib
* Source - https://bitbucket.org/ecollins/passlib/src
* Issues - https://bitbucket.org/ecollins/passlib/issues
Source
=========
Passlib's source repository uses Mercurial. When building Passlib from an hg clone, note that there are two main branches: ``default`` and ``stable``.
* ``default`` is the bleeding edge of the next major release. It may sometimes be of alpha quality.
* ``stable`` is the latest released version plus any pending bugfixes, and should be safe to use in production.
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment