wheezy.validation / doc / gettingstarted.rst

Full commit

Getting Started


:ref:`wheezy.validation` 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.validation

If you are using `virtualenv`_::

    $ virtualenv env
    $ env/bin/easy_install wheezy.validation


You can get the `source code`_ using `mercurial`_::

    $ hg clone
    $ cd wheezy.validation

Prepare `virtualenv`_ environment in *env* directory ::

    $ make env

... and run all tests::

    $ 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

.. _`pypi`:
.. _`python`:
.. _`setuptools`:
.. _`bitbucket`:
.. _`source code`:
.. _`mercurial`:
.. _`virtualenv`:
.. _`article`:
.. _`mind reference`:
.. _`doctest`:
.. _`sphinx`: