diff options
| author | Eli Collins <elic@assurancetechnologies.com> | 2011-06-30 22:15:05 -0400 |
|---|---|---|
| committer | Eli Collins <elic@assurancetechnologies.com> | 2011-06-30 22:15:05 -0400 |
| commit | e36d4e8b3e5a58f4274dc2b25a291f03379fba1c (patch) | |
| tree | 9417f97ac300ec684b0bea5ff633e3790f940c69 /docs/install.rst | |
| parent | fa2099ff2b1e0adb6b0d3b262d51d3d3f4cba364 (diff) | |
| download | passlib-e36d4e8b3e5a58f4274dc2b25a291f03379fba1c.tar.gz | |
misc documentation tweaks
Diffstat (limited to 'docs/install.rst')
| -rw-r--r-- | docs/install.rst | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/docs/install.rst b/docs/install.rst index fe2c048..28a9172 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -6,7 +6,7 @@ Supported Platforms =================== Passlib requires Python 2 (>= 2.5) or Python 3. It should work with the following Python implementations: - + * CPython 2 -- 2.5 or newer. * CPython 3 -- all versions. * PyPy -- 1.5 or newer. @@ -14,12 +14,12 @@ It should work with the following Python implementations: Passlib should work with all operating systems, as it contains builtin fallbacks -for almost all OS-dependant features. +for almost all OS-dependant features. Optional Libraries ================== * `py-bcrypt <http://www.mindrot.org/projects/py-bcrypt/>`_ or - `bcryptor <https://bitbucket.org/ares/bcryptor/overview>`_ + `bcryptor <https://bitbucket.org/ares/bcryptor/overview>`_ If either of these packages are installed, they will be used to provide support for the BCrypt hash algorithm. @@ -32,7 +32,7 @@ Optional Libraries If installed, M2Crypto will be used to accelerate some internal functions used by PBKDF2-based hashes, but it is not required even in that case. - + Installation Instructions ========================= To download and install using :command:`easy_install`:: @@ -42,16 +42,16 @@ To download and install using :command:`easy_install`:: To download and install using :command:`pip`:: pip install passlib - + To install from a source directory using :command:`setup.py`:: - python setup.py install + python setup.py install .. note:: - + Passlib's source ships as Python 2 code, and the setup script invokes the :command:`2to3` tool + a preprocessor - to translate the source to Python 3 code at install time. + to translate the source to Python 3 code at install time. Aside from this internal detail, installation under Python 3 should be identical to that of Python 2. @@ -76,6 +76,8 @@ Once PassLib and Nose have been installed, the tests may be run from the source PASSLIB_TESTS="all" nosetests -v passlib/tests --with-coverage \ --cover-package=passlib --cover-html --cover-html-dir build/coverage +(There will be a large proportion of skipped tests, this is normal). + Documentation ============= The latest copy of this documentation should always be available |