******
**Release Date: 16 Jan 2020**
Added
=====
General
-------
* Added the ``__version__`` global variable in the :py:mod:`khorosjx` (``__init__.py``) module.
Primary Modules
---------------
Additions to the :doc:`primary modules <primary-modules>`.
* Added the :py:func:`khorosjx.core.delete` function.
* Added the :py:func:`khorosjx.content.docs.create_document` function.
* Added the :py:func:`khorosjx.content.docs.delete_document` function.
* Added the :py:func:`khorosjx.places.base.get_uri_for_id` function.
* Added the :py:func:`khorosjx.content.docs.get_url_for_id` function.
Supporting Modules
------------------
Additions to the :doc:`supporting modules <supporting-modules>`.
* Added the :py:func:`khorosjx.utils.helper.__get_modules_to_import` function.
* Added the :py:exc:`khorosjx.errors.exceptions.DatasetNotFoundError` exception class.
* Added the ``uri_dataset_mapping`` and ``security_group_uri_map`` dictionaries to the
:py:class:`khorosjx.utils.classes.Content` class.
* Added the :py:func:`khorosjx.utils.core_utils.identify_dataset` function with the accompanying internal functions:
* :py:func:`khorosjx.utils.core_utils.__get_security_group_dataset`
* :py:func:`khorosjx.utils.core_utils.__get_invite_dataset`
* :py:func:`khorosjx.utils.core_utils.__get_metadata_dataset`
* :py:func:`khorosjx.utils.core_utils.__get_moderation_dataset`
* :py:func:`khorosjx.utils.core_utils.__get_search_dataset`
* :py:func:`khorosjx.utils.core_utils.__get_support_center_dataset`
* :py:func:`khorosjx.utils.core_utils.__get_tile_dataset`
* Added the :py:mod:`khorosjx.utils.version` module containing the source ``__version__`` and the following functions:
* :py:func:`khorosjx.utils.version.get_full_version()`
* :py:func:`khorosjx.utils.version.get_major_minor_version()`
Changed
=======
General
-------
* Updated `setup.py <https://github.com/jeffshurtliff/khorosjx/blob/master/setup.py>`_ to obtain the ``version``
value from the :py:func:`khorosjx.utils.version` function.
* Updated `docs/conf.py <https://github.com/jeffshurtliff/khorosjx/blob/master/docs/conf.py>`_ to obtain
the ``version`` value from the :py:func:`khorosjx.utils.version` function.
Primary Modules
---------------
Changes to the :doc:`primary modules <primary-modules>`.
* Updated the :py:mod:`khorosjx.places` module to proactively import the :py:mod:`khorosjx.places.base`,
:py:mod:`khorosjx.places.blogs` and :py:mod:`khorosjx.places.spaces` modules.
* Updated the :py:func:`khorosjx.content.docs.get_content_id` function to accept both URLs and Document IDs.
* Updated the :py:func:`khorosjx.init_helper` function to handle the ``modules`` section of the YAML configuration file.
* Added error handling for invalid file types in the :py:func:`khorosjx.init_helper` function.
* Updated the :py:func:`khorosjx.init_module` function to properly handle the ``all`` string within an iterable.
* Updated the :py:func:`khorosjx.core.get_fields_from_api_response` to reference the ``datasets`` dictionary that was
moved into the :py:class:`khorosjx.utils.classes.Content` class.
Supporting Modules
------------------
Changes to the :doc:`supporting modules <supporting-modules>`.
* Updated the :py:func:`khorosjx.utils.helper.parse_helper_cfg` and
:py:func:`khorosjx.utils.helper.retrieve_helper_settings` functions to leverage the
:py:func:`khorosjx.utils.helper.__get_modules_to_import` function.
* Added the ``accepted_import_modules`` and ``all_modules`` lists to the
:py:class:`khorosjx.utils.helper.HelperParsing` class.
* Moved the ``datasets`` dictionary from the :py:func:`khorosjx.core.get_fields_from_api_response` function into the
:py:class:`khorosjx.utils.classes.Content` class.
Documentation
-------------
Changes to the documentation.
* Adjusted the docstring for the :py:exc:`khorosjx.errors.exceptions.InvalidDatasetError` exception class to
differentiate it from the :py:exc:`khorosjx.errors.exceptions.DatasetNotFoundError` exception class.
Examples
--------
Changes to the example files found in the `examples <https://github.com/jeffshurtliff/khorosjx/tree/master/examples>`_
directory within the GitHub repository.
* Added the ``modules`` section to the
`khorosjx_helper.yml <https://github.com/jeffshurtliff/khorosjx/blob/master/examples/khorosjx_helper.yml>`_ file.
|
******