[05a128]: doc / source / installing_pyke.txt Maximize Restore History

Download this file

installing_pyke.txt    122 lines (92 with data), 4.6 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
.. $Id$
..
.. 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
/restindex
===================================
Installing Pyke
===================================
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 <http://python.org>`_
* `PLY 2.3 <http://www.dabeaz.com/ply/>`_
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 <http://sourceforge.net/projects/rest2web>`_
* `Docutils <http://sourceforge.net/projects/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``.