README 1.29 KB
Newer Older
Eli Collins's avatar
Eli Collins committed
1
2
.. -*- restructuredtext -*-

Eli Collins's avatar
Eli Collins committed
3
4
5
==========================
The PassLib Python Library
==========================
Eli Collins's avatar
Eli Collins committed
6

Eli Collins's avatar
Eli Collins committed
7
8
Welcome
=======
9
10
11
12
13
Passlib is a password hashing library for Python 2 & 3,
which provides cross-platform implementations of over 20
password hashing algorithms, as well 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,
Eli Collins's avatar
Eli Collins committed
14
15
to providing full-strength password hashing for multi-user application.

16
The latest documentation can be found online at `<http://packages.python.org/passlib>`_.
Eli Collins's avatar
Eli Collins committed
17
18

Requirements
Eli Collins's avatar
Eli Collins committed
19
============
Eli Collins's avatar
Eli Collins committed
20
21
* Python 2.5 - 2.7 or Python 3.x
* py-bcrypt or bcryptor (optional; required only if bcrypt support is needed)
Eli Collins's avatar
Eli Collins committed
22
* M2Crypto (optional; accelerates PBKDF2-based hashes)
Eli Collins's avatar
Eli Collins committed
23

Eli Collins's avatar
Eli Collins committed
24
Installation
Eli Collins's avatar
Eli Collins committed
25
============
Eli Collins's avatar
Eli Collins committed
26
27
To install from source using ``setup.py``::

Eli Collins's avatar
Eli Collins committed
28
   python setup.py install
Eli Collins's avatar
Eli Collins committed
29

Eli Collins's avatar
Eli Collins committed
30
31
32
33
For more detailed installation & testing instructions, see "docs/install.rst"

Online Resources
================
34
* Homepage -   http://passlib.googlecode.com
Eli Collins's avatar
Eli Collins committed
35
36
37
38
39
40
* Docs -       http://packages.python.org/passlib
* Discussion - http://groups.google.com/group/passlib-users

* PyPI -       http://pypi.python.org/pypi/passlib
* Downloads -  http://code.google.com/p/passlib/downloads
* Source -     http://code.google.com/p/passlib/source