summaryrefslogtreecommitdiff
path: root/README
blob: 7e55ecfe596e53019155defa9204a6c8f44ca1bb (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
.. -*- restructuredtext -*-

==========================
The PassLib Python Library
==========================

PassLib is a password hash library, which provides cross-platform
implementations of over 20 password hashing algorithms; as well as a framework for managing
and migrating existing password hashes. It's designed to be useful
for any task from quickly verifying a hash found in /etc/shadow,
to providing full-strength password hashing for multi-user application.

The latest documentation can be found online `XXX`.

Requirements
-----------
* Python 2.5 - 2.7
* PyBCrypt (optional; if bcrypt support is needed)
* M2Crypto (optional)

Installation
------------
To install from source using ``setup.py``::

   python setup.py build
   sudo python setup.py install

For more detailed installation & testing instructions, see "docs/install.rst",