Changelog¶
All notable changes to the SnipsKit project are documented in this file.
The format is based on Keep a Changelog, and this project adheres to the Semantic Versioning specification with major, minor and patch version.
Given a version number MAJOR.MINOR.PATCH, this project increments the:
- MAJOR version when incompatible API changes are made;
- MINOR version when functionality is added in a backwards-compatible manner;
- PATCH version when backwards-compatible bug fixes are made.
Warning
Note that major version zero (0.y.z) is for initial development. Anything may change at any time. The public API should not be considered stable. Before SnipsKit reaches version 1.0.0, the API does not adhere to the above specification, but the minor version is incremented when incompatible API changes are made.
0.6.0 - 2019-04-19¶
Added¶
- New module
snipskit.mqtt.clientwith helper functions to use the Paho MQTT library with the MQTT broker defined in aMQTTConfigobject.
Changed¶
- Breaking change: Refactored the
MQTTConfigobject. It now has auth (MQTTAuthConfig) and tls (MQTTTLSConfig) attributes for the authentication and TLS settings, respectively.
Fixed¶
snipskit.services.is_running()sometimes threw apsutil.NoSuchProcessexception when it tried to get the name of a process that no longer existed. Caught by Travis CI in job #201.4.
0.5.4 - 2019-04-11¶
Added¶
- New function
snipskit.tools.latest_snips_version()that returns the latest version of the Snips platform, as published in the release notes. - Documented the use of
SnipsAppMixin.assistantto get access to the assistant’s configuration outside of an app.
Fixed¶
- Removed ‘/usr/local/etc/assistant/assistant.json’ as a default path for
AssistantConfig. This was added erroneously in version 0.5.3.
0.5.3 - 2019-04-11¶
Added¶
- New module
snipskit.serviceswith functions to check the versions of Snips services, whether a Snips service is installed or running and what the model version of Snips NLU is.
Fixed¶
- Added ‘/usr/local/etc/assistant/assistant.json’ as a default path for
AssistantConfig. This was meant to fix a bug reported in issue #4.
0.5.2 - 2019-04-09¶
Added¶
- New module
snipskit.mqtt.dialoguewith helper functionssnipskit.mqtt.dialogue.continue_session()andsnipskit.mqtt.dialogue.end_session()to continue and end a session.
0.5.1 - 2019-04-09¶
Fixed¶
- Example code in documentation fixed to use the new callback signature for methods of
MQTTSnipsComponent. - PyPi package was built incorrectly.
0.5.0 - 2019-04-08¶
Added¶
- Example code and documentation about accessing the app’s configuration, the assistant’s configuration and the configuration of Snips.
- Method
MQTTSnipsComponent.publish()to publish a payload, optionally encoded as JSON.
Changed¶
- Breaking change: The callback signature for methods of
MQTTSnipsComponenthas changed to (self, topic, payload). - Breaking change: the decorator
snipskit.mqtt.decorators.topic()now has an optional argument ‘json_decode’ to decode a JSON payload to a dict, which is True by default.
0.4.0 - 2019-03-25¶
Added¶
- Support for Python 3.7.
- Extra documentation about installation and usage.
Changed¶
- Breaking change: Moved all Hermes Python-related classes to
snipskit.hermessubmodules and all MQTT-related classes tosnipskit.mqttsubmodules. - Breaking change: Class
SnipsConfiguses the new classMQTTConfigfor its MQTT connection settings so it doesn’t depend on Hermes Python. - Breaking change: Use pip install snipskit[hermes] to install the Hermes Python dependency, and pip install snipskit[mqtt] to install the Paho MQTT dependency. This way you can use the
snipskit.hermesmodule without pulling in the Paho MQTT dependency, or thesnipskit.mqttmodule without pulling in the Hermes Python dependency.
0.3.0 - 2019-03-22¶
Added¶
- Extra documentation about installation and usage.
- Example code in directory examples.
- Script scripts/check_examples.sh to check example code with pylint.
Changed¶
- Breaking change: Refactored
SnipsAppMixin. DropSnipsAppMixin.get_assistant()method, add constructor.