blob: 8837e6ffb3deadb15eec9059379cdf3e09c71b6b (
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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
============
Installation
============
Requirements
============
* Python 2.5 - 2.7 is required.
.. note::
PassLib has not been tested with Python 2.4 or earlier,
and no guarantees are made about whether PassLib will work with those versions.
.. note::
Python 3.x is **not** yet supported, work is ongoing.
* `py-bcrypt <http://www.mindrot.org/projects/py-bcrypt/>`_ (optional)
If installed, pybcrypt will be used to support the BCrypt hash algorithm.
This is required if you want to handle BCrypt hashes,
and stdlib :mod:`!crypt` does not support BCrypt
(which is pretty much all non-BSD systems).
* `M2Crypto <http://chandlerproject.org/bin/view/Projects/MeTooCrypto>`_ (optional)
If installed, M2Crypto will be used to accelerate some
internal support functions, but it is not required.
PassLib is pure-python, and should be useable on all platforms.
Installing
==========
To install from source directory using ``setup.py`` (requires Setuptools or Distribute)::
python setup.py build
sudo python setup.py install
To install using easy_install::
easy_install passlib
To install using pip::
pip install passlib
Testing
=======
PassLib contains a comprehensive set of unittests providing nearly complete coverage.
All unit tests are contained within the :mod:`passlib.tests` package,
and are designed to be run using the `Nose <http://somethingaboutorange.com/mrl/projects/nose>`_ unit testing library.
Once PassLib and Nose have been installed, the tests may be run from the source directory::
# to run the platform-relevant tests...
nosetests -v passlib/tests
# to run all tests...
PASSLIB_TESTS="all" nosetests -v passlib/tests
Documentation
=============
The latest copy of this documentation should always be available
at the `PassLib homepage <http://www.assurancetechnologies.com/software/passlib>`_.
If you wish to generate your own copy of the documentation,
you will need to:
* install `Sphinx <http://sphinx.pocoo.org/>`_ (1.0 or better)
* install `astdoc <http://www.assurancetechnologies.com/software/astdoc>`_ (a bundle of custom sphinx themes & extensions
used by Assurance Technologies).
* download the PassLib source
* run :samp:`python docs/make.py clean html`.
Once Sphinx completes it's run, point a web browser to the file at :samp:`docs/_build/html/index.html`
to access the PassLib documentation in html format.
|
