Prepare v1.13.0 for release

kirsle · kirsle · commit 264cdad874d8 · 2016-07-21T11:09:07.000-07:00
diff --git a/Changes.md b/Changes.md
@@ -1,13 +1,24 @@
 Revision history for the Python package RiveScript.
 
-1.13.0  TBD
+1.13.0  Jul 21 2016
   - Restructure the code to keep it on par with the JavaScript and Go versions:
     - `rivescript.parser` now contains all the parsing code:
       `parse()` and `check_syntax()` are moved here.
+    - Triggers are stored internally in only one place now, like in the
+      JavaScript and Go versions. This makes some internal mappings simpler as
+      they now point to common references and don't duplicate data in memory.
+    - **Note:** Most of the new `rivescript.*` modules are still
+      private-use-only, even though many internal functions lost their
+      underscore prefixes. You should still only use the API functions exposed
+      by `rivescript.rivescript` or what is exported by the top level package.
+      The `rivescript.parser` API will be more public-facing in the future to
+      help with third party integrations (currently it still relies on a Python
+      object with methods `_say` and `_warn`).
   - Refactor the RiveScript interactive mode (`rivescript.interactive`) to use
     argparse instead of getopt and add a pretty ASCII logo.
   - Add `shell.py` as a possibly easier-to-access (and certainly
     easier-to-discover) shortcut to running RiveScript's interactive mode.
+    It accepts all the same options and works the same as before.
 
 1.12.3  Jul 8 2016
   - Fix the Python object macro handler to use `six.text_type` on the return
diff --git a/python-rivescript.spec b/python-rivescript.spec
@@ -3,7 +3,7 @@
 %global desc A scripting language to make it easy to write responses for a chatterbot.
 
 Name:           python-%{srcname}
-Version:        1.12.3
+Version:        1.13.0
 Release:        1%{?dist}
 Summary:        %{sum}
 
diff --git a/rivescript/__init__.py b/rivescript/__init__.py
@@ -20,7 +20,7 @@
 __docformat__  = 'plaintext'
 
 __all__      = ['rivescript']
-__version__  = '1.12.4'
+__version__  = '1.13.0'
 
 from .rivescript import RiveScript
 from .exceptions import (
diff --git a/rivescript/parser.py b/rivescript/parser.py
@@ -15,6 +15,14 @@
 class Parser(object):
     """The RiveScript language parser.
 
+    This class will soon become a stand-alone, public (developer) facing class
+    for simply parsing RiveScript code, running syntax checks, and getting a
+    data structure back. Currently, though, the `master` parameter must be a
+    Python class instance that has methods ``_say(self, message)`` and
+    ``_warn(self, message, fname='', lineno=0)``. If you want to use this class
+    in the mean time, you can create a small Python class that has these methods
+    and pass it as the ``master`` parameter.
+
     Parameters:
         master (RiveScript): A reference to the parent RiveScript bot instance,
             mostly useful for its debug methods like ``warn()``.
