Change Log

This page documents the additions, changes, fixes, deprecations and removals made in each release.

v2.6.0

Release Date: 2020-05-28

Changed

Primary Modules

Changes to the primary modules.


v2.5.3

Release Date: 2020-05-01

Changed

Primary Modules

Changes to the primary modules.

  • Added the optional quiet argument to the khorosjx.core.get_fields_from_api_response() function which silences any errors for being unable to locate API fields.

  • Added the optional quiet argument to the khorosjx.core.get_paginated_results() function which silences any errors for being unable to locate API fields.

  • Added the optional quiet argument to the khorosjx.groups.get_group_memberships() function which silences any errors for being unable to locate API fields.

  • Added the optional quiet argument to the khorosjx.groups._add_paginated_members() function which silences any errors for being unable to locate API fields.

  • Removed the unnecessary variable definition of added_to_group within the khorosjx.groups.add_user_to_group() function.

  • Renamed the khorosjx.core.__get_filter_syntax() function to be khorosjx.core._get_filter_syntax() instead.

  • Renamed the khorosjx.core.__api_request_with_payload() function to be khorosjx.core._api_request_with_payload() instead.

Documentation

Changes to the documentation.

  • Added a docstring to the khorosjx.core._get_filter_syntax() function.

Fixed

Primary Modules

Fixes to the primary modules.


v2.5.2

Release Date: 2020-04-29

Fixed

Supporting Modules

Fixes to the supporting modules.

  • Fixed the khorosjx.utils.helper._convert_yaml_to_bool() function to only perform its operations if the passed value is not a Boolean value to prevent the following AttributeError exception from occurring: AttributeError: 'bool' object has no attribute 'lower'

v2.5.1

Release Date: 2020-04-29

Added

Supporting Modules

Additions to the supporting modules.

General

Changed

Primary Modules

Changes to the primary modules.

Supporting Modules

Changes to the supporting modules.

  • Replaced the yaml.load() function call with yaml.safe_load() in khoros.utils.helper.import_yaml_file() as it is a better security practice.

  • Renamed the khorosjx.utils.helper.__get_connection_info() function to be khorosjx.utils.helper._get_connection_info() instead.

  • Renamed the khorosjx.utils.helper.__get_credentials_from_module() function to be khorosjx.utils.helper._get_credentials_from_module() instead.

  • Renamed the khorosjx.utils.helper.__parse_function_arguments() function to be khorosjx.utils.helper._parse_function_arguments() instead.

  • Renamed the khorosjx.utils.helper.__get_console_color_settings() function to be khorosjx.utils.helper._get_console_color_settings() instead.

  • Renamed the khorosjx.utils.helper.__get_modules_to_import() function to be khorosjx.utils.helper._get_modules_to_import() instead.

  • Renamed the khorosjx.utils.helper.__convert_yaml_to_bool() function to be khorosjx.utils.helper._convert_yaml_to_bool() instead.

Fixed

Primary Modules

Fixes to the primary modules.

Documentation

Fixes to the documentation.


v2.5.0

Release Date: 2020-03-25

Changed

Primary Modules

Changes to the primary modules.

Documentation

Changes to the documentation.

Fixed

Security

Fixes relating to security vulnerabilities.

Documentation

Fixes to the documentation.


v2.4.1

Release Date: 2020-03-23

Fixed

Primary Modules

Additions to the primary modules.

  • Added the verify_core_connection() function call to the khorosjx.content.base.__convert_lookup_value() function to resolve the NameError: name 'base_url' is not defined error.

  • Added missing docstrings to the khorosjx.content.ideas.get_ideas_for_space() function.


v2.4.0

Release Date: 2020-03-16

Added

Primary Modules

Additions to the primary modules.

Supporting Modules

Additions to the supporting modules.

Changed

Primary Modules

Changes to the primary modules.

Fixed

Primary Modules

Fixes to the primary modules.

Documentation

Changes to the documentation.


v2.3.1

Release Date: 2020-02-24

Changed

General

  • Adjusted the python_requires value in setup.py to reject version 3.8.1 and above as the numpy and pandas packages do not currently support that version.

  • Upgraded the bleach package to version 3.1.1 to mitigate a security alert for a mutation XSS vulnerability and updated the requirements.txt file accordingly.


v2.3.0

Release Date: 2020-02-11

Changed

Primary Modules

Changes to the primary modules.

Supporting Modules

Changes to the supporting modules.

Fixed

Primary Modules

Fixes to the primary modules.

Removed

General

  • Removed the MANIFEST.in file as the VERSION file is no longer used.


v2.2.0

Release Date: 2020-01-22

Added

Primary Modules

Additions to the primary modules.

Supporting Modules

Additions to the supporting modules.

Changed

General

Primary Modules

Changes to the primary modules.

v2.1.0

Release Date: 16 Jan 2020

Added

General

  • Added the __version__ global variable in the khorosjx (__init__.py) module.

Primary Modules

Additions to the primary modules.

Supporting Modules

Additions to the supporting modules.

Changed

General

Primary Modules

Changes to the primary modules.

Supporting Modules

Changes to the supporting modules.

Documentation

Changes to the documentation.

Examples

Changes to the example files found in the examples directory within the GitHub repository.


v2.0.0

Release Date: 8 Jan 2020

Added

Primary Modules

Additions to the primary modules.

Supporting Modules

Additions to the supporting modules.

Documentation

Additions to the documentation.

Changed

General

  • Changed the Development Status PyPI classifier in the setup.py file to be 5 - Production/Stable.

Primary Modules

Changes to the primary modules.

Supporting Modules

Changes to the supporting modules.

  • Added df_utils and helper to __all__ in the khorosjx.utils module.

Documentation

Changes to the documentation.

  • Updated the Primary Modules page to show functions within the __init__.py files.

  • Added deprecated directives to docstrings of deprecated functions.

  • Adjusted the docstrings on the khorosjx.init_helper() function.

  • Restructured the table of contents at the top of the Supporting Modules page.

  • Updated the short-term and long-term items on the Roadmap page.

Fixed

Primary Modules

Fixes applied in the primary modules.

Supporting Modules

Fixes applied in the supporting modules.

Documentation

Fixes applied to the documentation.

Deprecated

Primary Modules

Deprecations in the primary modules.

Removed

Primary Modules

Removals in the primary modules.

  • The khorosjx.content module has been removed. (See the previous sections for additional context.)

Return to Top


v1.7.0

Release Date: 2019-12-21

Added

Primary Modules

Additions to the primary modules.


Supporting Modules

Additions to the supporting modules.

Changed

Primary Modules

Changes to the primary modules.


Supporting Modules

Changes to the supporting modules.

Fixed

Primary Modules

Fixes in the primary modules.

Deprecated

Supporting Modules

Deprecations in the supporting modules.

Return to Top


v1.6.0

Release Date: 2019-12-17

Added

Primary Modules

Additions to the primary modules.


Supporting Modules

Additions to the supporting modules.


Documentation

Addition to the documentation in this release.

  • Added a Roadmap page to list upcoming enhancements and changes.

Changed

Primary Modules

Changes to the primary modules.


Supporting Modules

Changes to the supporting modules.


Documentation

Changes to the documentation in this release.

  • Changed the project name from KhorosJX to Khoros JX Python Library in the conf.py script.

  • Made adjustments to the toctree directives on the index page.

  • Changed the Latest Release badge in the README.md file to be labeled Latest Stable Release instead.

Fixed

Primary Modules

Fixes to the primary modules.


Supporting Modules

Fixes to the supporting modules.

  • Removed the **kwargs argument in the super() call within all custom exceptions.


Documentation

Fixes in the documentation in this release.

Return to Top


v1.5.0

Release Date: 2019-12-05

Added

Primary Modules

Additions to the primary modules.


Supporting Modules

Additions to the supporting modules.


Documentation

Changed

Fixed

Return to Top


v1.4.0

Release Date: 2019-11-30

Added

Primary Modules

Additions to the primary modules.


Supporting Modules

Additions to the supporting modules.

Changed

Supporting Modules

Changes in the supporting modules.

Documentation

  • Changed the structure of the changelog to be more concise. (i.e. less sub-sections)

Developer Changes

Removed

Primary Modules

Removals in the primary modules.

Return to Top


v1.3.0

Release Date: 2019-11-27

Added

Primary Modules

Additions to the primary modules.


Supporting Modules

Additions to the supporting modules.


Examples

  • Added a new examples directory containing the khorosjx_helper.yml file which demonstrates how the helper configuration file should be formatted.


Documentation

Return to Top


v1.2.0

Release Date: 2019-11-24

Added

Primary Modules

Additions to the primary modules.



Documentation

  • Added the Core Functionality page with instructions on leveraging the core functionality of the library. (Page is still a work in progress)

  • Added the Managing Users page with instructions on managing users by leveraging the library. (Page is still a work in progress)

  • Added the Basic Usage page with the intent of inserting it into more than one page.

Changed

General

  • Updated the classifiers in setup.py to specifically reference Python 3.6, 3.7 and 3.8.


Primary Modules

Changes to existing functions in the primary modules.


Supporting Modules

Changes to existing functions in the supporting modules.


Documentation

Return to Top


v1.1.1

Release Date: 2019-11-23

Added

Changed

Removed

  • The khorosjx.errors.raise_exceptions() function is no longer necessary as the exception classes now have default messages and it has been removed from the khorosjx.errors module (__init__.py) and the Handlers Module (khorosjx.errors.handlers).

  • Removed the khorosjx.errors.exceptions.ExceptionMapping and khorosjx.errors.exceptions.ExceptionGrouping classes as they are no longer used.

Return to Top


v1.1.0

Release Date: 2019-11-22

Added

Primary Modules

Additions to the primary modules.


Changed

Deprecated

  • The raise_exception() function in the khorosjx.errors module now displays a DeprecationWarning as it has been moved into the new Handlers Module (khorosjx.errors.handlers).

  • Added a PendingDeprecationWarning warning on the khorosjx.errors.handlers.raise_exception() function as it will be deprecated in a future release. (See v1.1.1)

Fixed

Return to Top


v1.0.1.post1

Release Date: 2019-11-19

Changed

Return to Top


v1.0.1

Release Date: 2019-11-19

Changed

  • Removed the version from the individual module header blocks as all will adhere to the primary versioning.

Fixed

Return to Top