Merge pull request #10 from ian-andrich/cjm-fixes

Prep for next release

Author: cmungall

CHANGES.md

@@ -0,0 +1,7 @@
+## v0.2.0
+
+ * Various refactoring, see https://github.com/ian-andrich/PythonPengines/pull/5
+
+## v0.1.4 : More fat fingering.
+## v0.1.3 : Fat fingered some pypi code.
+## v0.1.2 : Added repo to pypi under the name PythonPengines

Makefile

@@ -0,0 +1,10 @@
+test:
+	pytest tests/srctest_test.py
+
+# TODO: manually increment version in setup.py, run . bump.sh, then this
+release: cleandist
+	python setup.py sdist bdist_wheel bdist_egg
+	twine upload dist/*
+
+cleandist:
+	rm dist/* || true

README.md

@@ -0,0 +1,95 @@
+Python Pengines
+===============
+
+This is a module for interfacing python with the Prolog Pengines
+knowledge base.
+
+API
+---
+
+Create a basic run pengine server script, and run it with swipl.
+
+::
+
+    :- use_module(library(http/thread_httpd)).
+    :- use_module(library(http/http_dispatch)).
+    :- use_module(library(pengines)).
+
+    server(Port) :- http_server(http_dispatch, [port(Port)]).
+
+    :- server(4242).
+
+Initialize a basic PengineBuilder
+
+::
+
+    from pengines.Builder import PengineBuilder
+    from pengines.Pengine import Pengine
+
+    pengine_builder = PengineBuilder(urlserver="http://localhost:4242")
+
+Create the pengine querying object.
+
+::
+
+    pengine = Pengine(builder=pengine_builder)
+    pengine.create()
+
+Make your query -- note the lack of ending period -- Pengine performs
+the query like 'ask(member(X, [1,2,3], [])).'
+
+::
+
+    query = "member(X, [1,2,3])"
+    pengine.ask(query)
+    print(pengine.currentQuery.availProofs)
+
+Iterate through the proofs like this:
+
+::
+
+    while pengine.currentQuery.hasMore:
+        pengine.doNext(pengine.currentQuery)
+        print(pengine.currentQuery.availProofs)
+
+prologterms library
+-------------------
+
+The python library prologterms aims to make it easier to construct
+prolog programs and query terms from within python.
+
+For an example of how to use prologterms in conjunction with pengines,
+see:
+
+https://pypi.org/project/prologterms/
+
+::
+
+    from pengines.Builder import PengineBuilder
+    from pengines.Pengine import Pengine
+    from prologterms import TermGenerator, PrologRenderer, Program, Var
+    
+    P = TermGenerator()
+    X = Var('X')
+    Y = Var('Y')
+    Z = Var('Z')
+    R = PrologRenderer()
+    
+    p = Program(
+        P.ancestor(X,Y) <= (P.parent(X,Z), P.ancestor(Z,Y)),
+        P.ancestor(X,Y) <= P.parent(X,Y),
+        P.parent('a','b'),
+        P.parent('b','c'),
+        P.parent('c','d')
+    )
+    
+    q = P.ancestor(X,Y)
+    
+    factory = PengineBuilder(urlserver="http://localhost:4242",
+                             srctext=R.render(p),
+                             ask=R.render(q))
+    pengine = Pengine(builder=factory, debug=True)
+    while pengine.currentQuery.hasMore:
+        pengine.doNext(pengine.currentQuery)
+    for p in pengine.currentQuery.availProofs:
+        print('{} <- {}'.format(p[X.name], p[Y.name]))

README.rst

@@ -1 +1,2 @@
 pytest>=0.0
+requests>=0.0

requirements.txt

@@ -2,7 +2,7 @@
 setup(
     name = "pengines",
     packages = ["pengines"],
-    version = "0.1.4",
+    version = "0.1.5",
     description = "A simple python library for interacting with SWI-Prologs Pengines",
     author = "Ian Andrich",
     author_email = "iandrich87+github@gmail.com",

setup.py

@@ -0,0 +1,7 @@
+:- use_module(library(http/thread_httpd)).
+:- use_module(library(http/http_dispatch)).
+:- use_module(library(pengines)).
+
+server(Port) :- http_server(http_dispatch, [port(Port)]).
+
+:- server(4242),T is 10**10,sleep(T).

tests/server.pl

@@ -1,7 +1,18 @@
+"""
+Assumes a bare-bones pengines service running on 4242
+
+You can use this:
+
+    docker run -p 4242:9083 -e PORT=9083 --name sparqlprog cmungall/sparqlprog
+
+"""
 from pengines.Builder import PengineBuilder
 from pengines.Pengine import Pengine
 
 def test_src():
+    """
+    
+    """
     src = "foo(a).\nfoo(b).\nfoo(c)."
     q = "foo(X)"
     factory = PengineBuilder(urlserver="http://localhost:4242", destroy=False, srctext=src, ask=q)