docs/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2020 AT&T Intellectual Property
   4
   5 Release Notes
   6 ===============
   7
   8 All notable changes to this project will be documented in this file.
   9
  10 The format is based on `Keep a Changelog <http://keepachangelog.com/>`__
  11 and this project adheres to `Semantic Versioning <http://semver.org/>`__.
  12
  13 .. contents::
  14    :depth: 3
  15    :local:
  16
  17 [0.4.0] - 3/13/2020
  18 -------------------
  19 ::
  20
  21     * minor breaking change; switches the default behavior RE threading for RMRXapps. The default is not to return execution, but the caller (in `run`) can choose to loop in a thread.
  22
  23
  24 [0.3.0] - 3/10/2020
  25 -------------------
  26 ::
  27
  28     * Large change to the "feel" of this framework: rather than subclass instantiation, xapps now use initialization and registration functions to register handlers
  29     * rmr xapps can now register handlers for specific message types (and they must prodive a default callback); if the user does this then "message to function routing" is now handled by the framework itself
  30     * RMRXapp now runs the polling loop in a thread, and returns execution back to the caller. The user is then free to loop, or do nothing, and call stop() when they want.
  31     * Raises tox coverage minimum to 70 from 50 (currently at 86)
  32
  33 [0.2.0] - 3/3/2020
  34 -------------------
  35 ::
  36
  37     * now allows for RMRXapps to call code before entering the infinite loop
  38     * stop is now called before throwing NotImplemented in the case where the client fails to provide a must have callback; this ensures there is no dangling rmr thread
  39     * stop now calls rmr_close to correctly free up any port(s)
  40     * (breaking) renames `loop` to `entrypoint` since the function does not have to contain a loop (though it most likely does)
  41     * Changes wording around the two types of xapps (docs only)
  42     * Uses a new version of rmr python that crashes when the rmr mrc fails to init, which prevents an xapp trying to use an unusable rmr
  43     * more unit test code coverage
  44     * Adds more fields to setup like long_desc and classifiers so the pypi page looks nicer
  45     * Removes a bad release file (will be added back in subseq. commit)
  46
  47 [0.1.0] - 2/27/2020
  48 -------------------
  49 ::
  50
  51     * Initial commit