Getting Started
===============


Install
-------

:ref:`weblayer` requires `Python`_ version 2.5 to 2.7.  It's operating system
independent, so runs on Unix (including Mac OSX) and on Windows.  Install it
via the `Python Package Index`_ using `Setuptools`_::

    easy_install weblayer

Develop
-------

To develop (or play around with) it, get the `source code`_ using `Git`_::

    git clone git://github.com/thruflo/weblayer.git
    cd weblayer

Develop the egg::

    python setup.py develop

Install the additional dependencies::

    easy_install weblayer[dev]

Run the tests::

    nosetests -c etc/nose.cfg
    
Generate the docs::

    sphinx-build -a -b html doc doc/_build

If you have any problems or suggestions, `Github Issues`_ is the place to raise
a ticket.

.. _`git`: http://git-scm.com/
.. _`github issues`: http://github.com/thruflo/weblayer/issues
.. _`python`: http://www.python.org
.. _`python package index`: http://pypi.python.org/pypi/weblayer
.. _`setuptools`: http://pypi.python.org/pypi/setuptools
.. _`source code`: http://github.com/thruflo/weblayer