summaryrefslogtreecommitdiff
path: root/README
blob: a0468c31465026ea7fb790e7c684483f612240de (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
29
30
31
32
33
34
35
36
37
38
39
.. -*- restructuredtext -*-

==========================
The Passlib Python Library
==========================

Welcome
=======
Passlib is a password hashing library for Python 2 & 3, which provides
cross-platform implementations of over 30 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, to
providing full-strength password hashing for multi-user application.

The latest documentation can be found online at `<http://packages.python.org/passlib>`_.

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)

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

   python setup.py install

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

Online Resources
================
* Homepage -   https://bitbucket.org/ecollins/passlib
* Docs -       http://packages.python.org/passlib
* Discussion - http://groups.google.com/group/passlib-users

* Downloads -  https://pypi.python.org/pypi/passlib
* Source -     https://bitbucket.org/ecollins/passlib/src