Andriy Kornatskyy avatar Andriy Kornatskyy committed d8a891d

Working on documentation

Comments (0)

Files changed (2)

-`wheezy.security`_ is a `python`_ package written in pure Python
-code. It provides security/cryptography features.
+`wheezy.security`_ is a `python`_ package written in pure Python code. 
+It is a lightweight security library that provides integration with:
+
+* `pycrypto`_ - The Python Cryptography Toolkit
+
+It is optimized for performance, well tested and documented.
+
+Resources:
+
+* `source code`_, `examples`_ and `issues`_ tracker are available
+  on `bitbucket`_
+* `documentation`_, `readthedocs`_
+* `eggs`_ on `pypi`_
 
 Install
 -------
 
-`wheezy.security`_ requires `python`_ version 2.4 to 2.7 or 3.2.  It
-is independent of operating system. You can install it using
-`setuptools`_::
+`wheezy.security`_ requires `python`_ version 2.4 to 2.7 or 3.2.
+It is independent of operating system. You can install it from `pypi`_
+site using `setuptools`_::
 
-    easy_install wheezy.security
+    $ easy_install wheezy.security
 
+If you are using `virtualenv`_::
+
+    $ virtualenv env
+    $ env/bin/easy_install wheezy.security
+
+If you would like take benefit of one of cryptography library that has
+built-in support specify extra requirements::
+
+    $ easy_install wheezy.security[pycrypto]
 
 Develop
 -------
 
-Get the `source code`_ using `mercurial`_::
+You can get the `source code`_ using `mercurial`_::
 
-    hg clone https://bitbucket.org/akorn/wheezy.security
-    cd wheezy.security
+    $ hg clone http://bitbucket.org/akorn/wheezy.security
+    $ cd wheezy.security
 
-Prepare virtualenv environment in *env* directory and run all
-tests for python2.6 (default)::
+Prepare `virtualenv`_ environment in *env* directory ::
 
-    make env test VERSION=2.6
+    $ make env
 
-doctests can be run with python3.2::
+... and run all tests::
 
-    make env doctest-cover VERSION=3.2
+    $ make test
+
+You can read how to compile from source code different versions of
+`python`_ in the `article`_ published on `mind reference`_ blog.
+
+You can run certain make targets with specific python version. Here
+we are going to run `doctest`_ with python3.2::
+
+    $ make env doctest-cover VERSION=3.2
+
+Generate documentation with `sphinx`_::
+
+	$ make doc
 
 If you run into any issue or have comments, go ahead and add on
 `bitbucket`_.
 
-User Guide and Examples
------------------------
+.. _`article`: http://mindref.blogspot.com/2011/09/compile-python-from-source.html
+.. _`bitbucket`: http://bitbucket.org/akorn/wheezy.security/issues
+.. _`doctest`: http://docs.python.org/library/doctest.html
+.. _`documentation`: http://packages.python.org/wheezy.security
+.. _`eggs`: http://pypi.python.org/pypi/wheezy.security
+.. _`examples`: http://bitbucket.org/akorn/wheezy.security/src/tip/demos
+.. _`issues`: http://bitbucket.org/akorn/wheezy.security/issues
+.. _`mercurial`: http://mercurial.selenic.com/
+.. _`mind reference`: http://mindref.blogspot.com/
+.. _`pycrypto`: https://www.dlitz.net/software/pycrypto/
+.. _`pypi`: http://pypi.python.org/pypi/wheezy.security
+.. _`pypi`: http://pypi.python.org/pypi/wheezy.security
+.. _`python`: http://www.python.org
+.. _`readthedocs`: http://readthedocs.org/builds/wheezysecurity/
+.. _`setuptools`: http://pypi.python.org/pypi/setuptools
+.. _`source code`: http://bitbucket.org/akorn/wheezy.security/src
+.. _`sphinx`: http://sphinx.pocoo.org/
+.. _`virtualenv`: http://pypi.python.org/pypi/virtualenv
+.. _`wheezy.security`: http://pypi.python.org/pypi/wheezy.security
 
-Please see the `user guide`_ and `examples`_ for more
-information.
-
-.. _`wheezy.security`: http://pypi.python.org/pypi/wheezy.security
-.. _`python`: http://www.python.org
-.. _`setuptools`: http://pypi.python.org/pypi/setuptools
-.. _`documented`: http://packages.python.org/wheezy.security
-.. _`examples`: https://bitbucket.org/akorn/wheezy.security/src/tip/demos/
-.. _`bitbucket`: https://bitbucket.org/akorn/wheezy.security
-.. _`source code`: https://bitbucket.org/akorn/wheezy.security/src
-.. _`mercurial`: http://mercurial.selenic.com/
-.. _`user guide`: http://packages.python.org/wheezy.security/userguide.html
 
 * `source code`_, `examples`_ and `issues`_ tracker are available
   on `bitbucket`_
-* `documentation`_
+* `documentation`_, `readthedocs`_
 * `eggs`_ on `pypi`_
 
 Contents
    userguide
    modules
 
+.. _`bitbucket`: http://bitbucket.org/akorn/wheezy.security
+.. _`documentation`: http://packages.python.org/wheezy.security
+.. _`eggs`: http://pypi.python.org/pypi/wheezy.security
+.. _`examples`: http://bitbucket.org/akorn/wheezy.security/src/tip/demos
+.. _`issues`: http://bitbucket.org/akorn/wheezy.security/issues
+.. _`pycrypto`: https://www.dlitz.net/software/pycrypto/
+.. _`pypi`: http://pypi.python.org
 .. _`python`: http://www.python.org
+.. _`readthedocs`: http://readthedocs.org/builds/wheezysecurity/
 .. _`source code`: http://bitbucket.org/akorn/wheezy.security/src
-.. _`bitbucket`: http://bitbucket.org/akorn/wheezy.security
-.. _`issues`: http://bitbucket.org/akorn/wheezy.security/issues
-.. _`documentation`: http://packages.python.org/wheezy.security
-.. _`examples`: http://bitbucket.org/akorn/wheezy.security/src/tip/demos
-.. _`pypi`: http://pypi.python.org
-.. _`eggs`: http://pypi.python.org/pypi/wheezy.security
-.. _`pycrypto`: https://www.dlitz.net/software/pycrypto/
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.