Tree [73803c] default /
History



File Date Author Commit
Test 2009-10-28 mtnyogi mtnyogi [b14ef5] Fixed CanNotProve2.tst to no longer use setup.py.
doc 2009-11-02 mtnyogi mtnyogi [73803c] Numerous changes preparing for new installation...
examples 2009-10-28 mtnyogi mtnyogi [ff7730] merged and tested
experimental 2009-10-28 mtnyogi mtnyogi [ff7730] merged and tested
pyke 2009-10-28 mtnyogi mtnyogi [ff7730] merged and tested
.hgignore 2009-07-25 mtnyogi mtnyogi [c9dde1] Added .hgignore
.hgtags 2009-10-19 mtnyogi mtnyogi [f9977b] Added tag 1.0.3 for changeset ca5211a03a2d
MANIFEST.in 2009-11-02 mtnyogi mtnyogi [73803c] Numerous changes preparing for new installation...
README 2009-11-02 mtnyogi mtnyogi [73803c] Numerous changes preparing for new installation...
RELEASE_NOTES-1.0.txt 2009-11-02 mtnyogi mtnyogi [73803c] Numerous changes preparing for new installation...
RELEASE_NOTES-pre1.0.txt 2009-11-02 mtnyogi mtnyogi [73803c] Numerous changes preparing for new installation...
copyright_license 2007-10-15 mtnyogi mtnyogi [9cc939] Added svn:keywords properties. Some work on doc...
ez_setup.py 2009-04-21 mtnyogi mtnyogi [2f5b42] - Added test with compiled_krb files in eggs.
hgrc_keywords 2009-07-25 mtnyogi mtnyogi [c9dde1] Added .hgignore
make_doc_zip 2009-11-02 mtnyogi mtnyogi [73803c] Numerous changes preparing for new installation...
setup.py 2009-11-02 mtnyogi mtnyogi [73803c] Numerous changes preparing for new installation...
testall 2009-10-28 mtnyogi mtnyogi [132ab2] Added python version option to testall

Read Me

Pyke: Python Knowledge Engine

Version: 1.0.3

Both forward-chaining and backward-chaining rules (which may include python
code) are compiled into python. Can also automatically assemble python
programs out of python functions which are attached to backward-chaining
rules.

COPYRIGHT AND LICENSE:

This is published under the MIT License.  The copyright and license are in
the file "copyright_license".

DOCUMENTATION:

The documentation is at:

    http://pyke.sourceforge.net

You can download a copy of this documentation to your hard drive:

    pyke_doc_html-1.0.3.zip

See the end of this file for how to regenerate the html files.


INSTALLATION:

Pyke requires python 2.5 (or later).  Check with:

    $ python --version

You can download python at:

    http://www.python.org


SOURCE DISTRIBUTION:

There is a separate set of Pyke sources for Python3.1.

The pyke source distribution is the file:

    pyke-1.0.3.zip

This contains the pyke source code, documentation (both source and html), and
examples.

EXAMPLES:

Pyke examples may be downloaded separately from sourceforge if you've used
easy_install to install pyke (or installed the .egg file):

    pyke_examples-1.0.3.tar.gz

You need to unpack this into a directory that is on your PYTHON PATH.

Each example has a README file that explains how to run it.

The family_relations example is a good place to start.  It shows several
solutions to the same problem.  It also has an example of a few rule
optimizations that result in a 100 times performance improvement on this
problem.

The sqlgen example uses Sqlite3 (or MySQL) and the python sqlite3 (or MySQLdb)
modules.  It has a function that reads the schema information into pyke facts.
Then the rules in database.krb automatically figure out how to join tables
together to retrieve a list of column names, generate the SQL select
statements and return a plan to execute this SQL statement and return the
results as a dictionary.

The web_framework example uses the sqlgen example.  This demonstrates the use
of multiple rule bases.  The web_framework is a WSGI application that uses the
HTMLTemplate package (install this with "sudo easy_install HTMLTemplate", be
sure to get version 1.5 or later).  It gets the column names from the
HTMLTemplate and feeds those to the sqlgen example to generate a plan to
retrieve the data.  It then builds a plan to populate the template and return
the finished HTML document.  It also caches the plans so that they don't have
to be re-generated for each request.  This makes it run a full 10 times faster
than the same example done in TurboGears 2!  The example includes a wsgiref
simple_server setup to run it as an http server so that you can access it
through your browser.

The learn_pyke example is an incomplete attempt at a computer based training
program.  It only deals with the topic of pattern matching.  It is left here
as an example of using question bases.

The findall, forall, knapsack, notany and towers_of_hanoi examples are each
very small.


TO INSTALL FROM THE SOURCES:

    $ python setup.py install


RUNNING DOCTESTS:

Pyke uses the doctest-tools package to run its doctests.  You can run the
"testall" program from doctest-tools in any subdirectory, or in the top-level
directory.  You can install doctest-tools with:

    $ sudo easy-install doctest-tools

The top-level directory also has it's own "testall" script that removes all
compiled_krb directories, then runs the standard testall scripts twice.  The
first time forces pyke to recompile everything, and the second time runs the
same tests again having pyke re-use the compiled results from the previous
run.  This "testall" program should not be on your path, so run it as:

    $ ./testall

to distinguish it from the "testall" program installed with doctest-tools.


WORKING WITH THE SOURCE CODE REPOSITORY:

If you want to run Python3.1, read this:

    http://pyke.hg.sourceforge.net/hgweb/pyke/pre_2to3/file/8788b112f5f6/README-3.x

COMPILING kfbparser_tables.py, krbparser_tables.py and scanner_tables.py:

    $ python
    >>> from pyke.krb_compiler import kfbparser, krbparser, scanner
    >>> scanner.init(scanner, 0, True)
    >>> krbparser.init(krbparser, True)
    >>> kfbparser.init(kfbparser, True)

    or just run the "testall" program from the doctest-tools package:

    $ cd pyke/krb_compiler
    $ testall


COMPILING THE COMPILER.KRB FILE:

In pyke/krb_compiler:

    $ PYTHONPATH=../.. python
    >>> from pyke import krb_compiler
    >>> krb_compiler.compile_krb('compiler', 'compiled_krb', 'compiled_krb', 'compiler.krb')
    $ mv compiled_krb/compiler_bc.py .

COMPILING THE DOCUMENTATION:

To compile the documentation into html, you'll need docutils and rest2web.
If you're running linux, your distro may have packages for these already.
Or you can:

    $ sudo easy_install rest2web

I used version 0.4.1 of docutils and 0.5.0 of rest2web.  I don't know if
earlier versions work OK or not.

To check your versions:

    $ python
    >>> import docutils
    >>> docutils.__version__
    >>> import rest2web
    >>> rest2web.__version__

If your linux distro doesn't have packages for these, and you don't want to
use easy_install, you can get them at:

    http://sourceforge.net/projects/docutils
    http://sourceforge.net/projects/rest2web

To regenerate the html:

    $ cd doc/source
    $ bin/gen_html

This regenerates everything from doc/source into doc/html.  It takes about
9 seconds to run.

If you want to run doctest on all of the *.txt files in doc/source, use the
"testall" program from the doctest-tools package:

    $ cd doc
    $ testall