.. $Id: installing_pyke.txt 50 2007-11-12 19:03:51Z mtnyogi $
.. 
.. Copyright © 2007 Bruce Frederiksen
.. 
.. Permission is hereby granted, free of charge, to any person obtaining a copy
.. of this software and associated documentation files (the "Software"), to deal
.. in the Software without restriction, including without limitation the rights
.. to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
.. copies of the Software, and to permit persons to whom the Software is
.. furnished to do so, subject to the following conditions:
.. 
.. The above copyright notice and this permission notice shall be included in
.. all copies or substantial portions of the Software.
.. 
.. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
.. IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
.. FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
.. AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
.. LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
.. OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
.. THE SOFTWARE.

restindex
    crumb: Installing Pyke
    page-description:
        System Requirements and installing pyke.
    /description
    format: rest
    encoding: utf8
    output-encoding: utf8
    include: yes
    initialheaderlevel: 1
/restindex

===================================
Installing Pyke
===================================

Index to This Page
=======================

* Licensing_
* `System Requirements`_
* Installation_

  * `Installing the Executables`_
  * `Installing the Sources`_
  * `Installing the Example`_
  * `Installing the HTML Documentation`_

* `Subversion Directories`_
* Documentation_

Licensing
================

This software is licensed under the MIT license:

    Permission is hereby granted, free of charge, to any person obtaining a copy
    of this software and associated documentation files (the "Software"), to deal
    in the Software without restriction, including without limitation the rights
    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    copies of the Software, and to permit persons to whom the Software is
    furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in
    all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    THE SOFTWARE.

System Requirements
====================

Pyke is 100% python, so it should run on any platform supported by python.
You'll need:

* `Python 2.5`_
* `PLY 2.3`_ (easy_install_ automatically installs this)

Installation
==================

Installing the Executables
----------------------------

Pyke is registered on pypi_, so once you have `python 2.5`_ with
easy_install_ you can just type (you'll probably need root permission)::

    $ easy_install-2.5 pyke

This will automatically install `PLY 2.3`_ too.

Installing the Sources
------------------------

The source code for the latest release can be found on the `pyke project
download page`_ as ``pyke-<release>.tar.gz``.

If you want the latest developer version, read `Subversion Directories`_,
below.

Installing the Example
-------------------------

At this point, there is a single example that is contained in the source
directory.  There is a README file that explains how to run it.

Installing the HTML Documentation
----------------------------------------

If you'd like to view the html documentation from you hard drive,
it is in the source directory (doc/html), or you can download just the
documentation itself as ``pyke_doc_html-<release>.zip`` file from the
`pyke project download page`_.

Subversion Directories
==========================

To check out the entire project (including the example and this documentation)
into a directory called *foobar*::

    $ svn checkout https://pyke.svn.sourceforge.net/svnroot/pyke/trunk foobar

Anybody can check out the code, but only project members may do
``commits``.  Send me an email if you'd like to lend a hand!

You'll see the following directories.  You can also use ``svn`` to check these
out individually by simply adding the directory name onto the end of the url in
the example above and changing the directory that you want it to go into.

* ``doc``

  - See `Documentation`_, below.

* ``examples``

  - Currently, there is only one example: *family_relations*.  Look at the
    ``README`` file there to see how to run it.

* ``pyke``
  
  - This is the top-level python package directory for the python sources.
    This needs to be in a directory on your ``PYTHONPATH``.
    The sources for the compiler is in the ``compiler`` subdirectory,
    which is expected to be a subpackage of ``pyke``.

Documentation
=================

The ``doc/html`` directory in subversion contains all of these documents.
You can browse these on your hard drive if you'd like.

If you want to regenerate these documents, you'll also need:

* Rest2web_, which requires:
* Docutils_

The sources for the documentation are in ``doc/sources``.

To regenerate the documentation, in the ``doc`` directory run::

    $ r2w r2w.ini

This will regenerate the files in ``doc/html``, except for those in
``doc/html/stylesheets`` and ``doc/html/images``.  I've gone ahead
and placed the generated html files in subversion so that you can checkout
the documentation without having to run ``r2w``.

.. _Docutils: http://sourceforge.net/projects/docutils
.. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall
.. _PLY 2.3: http://www.dabeaz.com/ply/
.. _pyke project download page:
        http://sourceforge.net/project/showfiles.php?group_id=207724
.. _pypi: http://pypi.python.org/pypi
.. _Python 2.5: http://python.org
.. _Rest2web: http://sourceforge.net/projects/rest2web
