https://github.com/ninjarobot/Pengines.Client

https://github.com/ninjarobot/Pengines.Client

Last synced: 4 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/ninjarobot/Pengines.Client
• Owner: ninjarobot
• License: bsd-2-clause
• Created: 2017-11-08T01:54:29.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2022-06-02T03:34:57.000Z (over 2 years ago)
• Last Synced: 2024-07-05T14:15:31.164Z (4 months ago)
• Language: F#
• Size: 37.1 KB
• Stars: 11
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-fsharp - Pengines.Client ★ 3 ⧗ 0 - sandboxed Prolog environment. [BSD-2-Clause] (Compilers)

README

        
Pengines Client for F#

========

Pengines is an HTTP service for evaluating Prolog build on the foundation of SWI-Prolog.  A client creates a [Pengine](http://www.swi-prolog.org/pengines/PengineConcept.html), which is a sandboxed Prolog environment, passes any Prolog facts and rules, then queries the facts and rules to obtain a list of solutions.

[![Build and Test](https://github.com/ninjarobot/Pengines.Client/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/ninjarobot/Pengines.Client/actions/workflows/build-and-test.yml)

[![Pengines.Client on Nuget](https://buildstats.info/nuget/Pengines.Client)](https://www.nuget.org/packages/Pengines.Client/)

Modules

-------

This client is designed with F# consumers in mind, and provides the following modules:

* `Pengines.Prolog` - F# discriminated unions for Prolog terms: this includes, atoms, numbers, lists, compound terms, operators, and the dictionary term supported by SWI-Prolog.

* `Pengines.Serialization` - serialize these terms to Prolog, and deserialize them from JSON,

* `Pengines.Pengine` - manage the lifetime of a Pengine instance - create, query, and destroy

* `Pengines.Operators` - helpful operators to make common Prolog operations more succinct from F#

System Requirements

--------

* [SWI-Prolog](http://www.swi-prolog.org/Download.html) - there are distributions available for Linux, macOS, and Windows.

* [Pengines](https://github.com/SWI-Prolog/pengines) - this is a small set of Prolog modules, available in a GitHub repo.

* [.NET Core Runtime](https://www.microsoft.com/net/download/core) - to use this library.  Or you can pull the [single file](src/Pengines.fs) into your F# 4.1 or greater project with [Paket](https://fsprojects.github.io/Paket/).

Usage

-----

1. Create a list of Prolog terms containing your facts and rules

2. Create a Pengine instance with `Pengines.Pengine.createPengine`, passing the list of terms and another term for a query to ask.

3. Iterate through the results.

4. Destroy the Pengine instance, which will delete the facts and rules.  It will timeout and self-destruct after 5 minutes without use if you don't.

Documentation

--------

Please see the [user guide](../../wiki/Using-Pengines.Client) for a walkthrough.

There are also [tests](tests/Tests.fs) that show usage of the complete API.