Merge pull request #2 from paulovn/feature/alice-1.9

Feature/alice 1.9

Author: paulovn

CHANGES.txt

@@ -1,17 +1,25 @@
 Changelog for python-aiml
 
- - refactored to make it compatible for both Python2 (tested on 2.7) & Python3
-   (tested on 3.4)
- - Default encoding behaviour for input & output strings: UTF-8 encoded
-   strings are used in Py2 (for backwards compatibility), unicode strings 
-   in Py3. This can be changed via the Kernel.setTextEncoding() method.
- - Tests moved from inside package to separate test files, and refactored
-   to use standard Python unit test infrastructure
- - Additional argument 'chdir' to Kernel.bootstrap() method
- - aimlvalidate & test scripts install as package scripts "aiml-validate" and
-   "aiml-bot". Thet have been refactored and contain additional arguments
- - The "standard" AIML set has been moved as package data, and installs with
-   it
+version 0.9.0
+
+* Refactored to make it compatible for both Python2 (tested on 2.7) & Python3 
+  (tested on 3.4)
+* By default utf8-encoded strings are used in Py2 (for backwards compatibility),
+  and standard strings (i.e unicode) in Py3
+   - This can be changed via the `Kernel.setTextEncoding()` method.
+* Tests moved from inside package to separate test files, and refactored to use
+  standard Python unit test infrastructure
+* Additional argument _chdir_ to `Kernel.bootstrap()` method
+* aimlvalidate & test scripts install now as package scripts aiml-validate and
+  aiml-bot. They have been refactored and contain additional arguments
+* The "standard" AIML set has been moved as package data, and installs with it
+* Added ALICE AIML v. 1.9 from aiml-en-us-foundation-alice at 
+  https://code.google.com/archive/p/aiml-en-us-foundation-alice/downloads
+  * aiml-en-us-foundation-alice has GNU Lesser GPL license
+    (http://www.gnu.org/licenses/lgpl.html)
+  * a few AIML 1.9 files have been corrected. Two of them have been commented
+    out since they use the AIML 2.0 <learn> construct
+
 
 
 ------------------------------------------------------------------------------

README.rst

@@ -2,10 +2,11 @@ python-aiml
 ***********
 
 This is a fork of the `PyAIML`_ Python AIML interpreter. It has been
-refactored to make it work in both Python 2 and Python 3.
+refactored to make it install and work in both Python 2.7 and Python 3.
 
 PyAIML is (c) Cort Stratton. *python-aiml* uses the same license as PyAIML 
-(2-clause BSD)
+(2-clause BSD), except for the ALICE AIML files taken from the `Free ALICE AIML
+set`_, which are licensed with the `LGPL`_ license.
 
 
 Scripts
@@ -18,6 +19,21 @@ Two small scripts are added upon installation:
   after loading either AIML files or a saved brain file.
 
 
+Datasets
+========
+
+The installation includes two AIML datasets:
+
+* The *standard* AIML set, as it was included in PyAIML
+* The `Free ALICE AIML set`_ v. 1.9, taken from the data published by the
+  `ALICE AI Foundation`_ (with a few small fixes in files that did not 
+  validate as `AIML 1.0.1`_)
+
+They can be loaded via the ``bootstrap`` method in the ``Kernel`` class. See 
+the `bot.py`_ script for an example.
+
+
+
 Tests
 =====
 
@@ -36,6 +52,11 @@ naming them in the command line; if none is specified all will be executed.
 
 
 .. _PyAIML: https://github.com/cdwfs/pyaiml
+.. _Free ALICE AIML set: https://code.google.com/archive/p/aiml-en-us-foundation-alice/
+.. _LGPL: http://www.gnu.org/licenses/lgpl.html
+.. _ALICE AI Foundation: http://alice.pandorabots.com/
+.. _bot.py: aiml/script/bot.py
+.. _AIML 1.0.1: http://www.alicebot.org/TR/2011/
 
 ------------------------------------------------------------------------------