Changes to framework usage:
[ric-plt/xapp-frame-py.git] / 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
18 [0.3.0] - 3/10/2020
19 -------------------
20 ::
21
22     * Large change to the "feel" of this framework: rather than subclass instantiation, xapps now use initialization and registration functions to register handlers
23     * 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
24     * 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.
25     * Raises tox coverage minimum to 70 from 50 (currently at 86)
26
27 [0.2.0] - 3/3/2020
28 -------------------
29 ::
30
31     * now allows for RMRXapps to call code before entering the infinite loop
32     * 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
33     * stop now calls rmr_close to correctly free up any port(s)
34     * (breaking) renames `loop` to `entrypoint` since the function does not have to contain a loop (though it most likely does)
35     * Changes wording around the two types of xapps (docs only)
36     * 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
37     * more unit test code coverage
38     * Adds more fields to setup like long_desc and classifiers so the pypi page looks nicer
39     * Removes a bad release file (will be added back in subseq. commit)
40
41 [0.1.0] - 2/27/2020
42 -------------------
43 ::
44
45     * Initial commit