v2.5.2

Release Date: 2020-05-25

Added

Primary Modules

Additions to the primary modules.

• Added the private function khoros.api._get_v2_return_values() to address possible KeyError exceptions in the khoros.api.deliver_v2_results() function.

Documentation

Additions to the documentation.

• Added the Working with Boards document as a tutorial for managing boards.

Changed

Primary Modules

Changes to the primary modules.

• Removed the assert function call from the khoros.core.Khoros._populate_construct_settings() method.

• Updated the khoros.api.parse_v2_response() function so that the http_code value returns as an integer rather than a string.

• Replaced the return_developer_message argument with return_error_messages in the khoros.api.parse_v2_response(), khoros.api.deliver_v2_results(), khoros.structures.boards.create() and khoros.core.Khoros.Board.create() functions.

• Updated the khoros.api.parse_v2_response() function to merge the message and developer_message response values into the error_msg field in the dictionary, and included the split_errors argument which determines if they should be split within a tuple or consolidated into a single string separated by a hyphen. (e.g. Invalid query syntax - An invalid value was passed...)

• Included the split_errors argument in the khoros.api.deliver_v2_results(), khoros.structures.boards.create() and khoros.core.Khoros.Board.create() functions.

Supporting Modules

Changes to the supporting modules.

• Renamed the khoros.utils.core_utils.__is_zero_length() function to be khoros.utils.core_utils._is_zero_length() instead.

• Renamed the khoros.utils.core_utils.__structure_query_string() function to be khoros.utils.core_utils._structure_query_string() instead.

Documentation

Changes to the documentation.

• Added the Working with Boards page to the Python SDK for Khoros Communities home page.

Return to Top

---

v2.5.1

Release Date: 2020-05-20

Added

Primary Modules

Additions to the primary modules.

• Added the khoros.studio module with the khoros.studio.base sub-module.

• Added the following functions to the khoros.studio.base module:

  • khoros.studio.base.sdk_installed()

  • khoros.studio.base.get_sdk_version()

  • khoros.studio.base.node_installed()

  • khoros.studio.base.get_node_version()

  • khoros.studio.base.npm_installed()

  • khoros.studio.base.get_npm_version()

• Added the khoros.core.Khoros.Studio subclass with the following functions:

  • khoros.core.Khoros.Studio.sdk_installed()

  • khoros.core.Khoros.Studio.get_sdk_version()

  • khoros.core.Khoros.Studio.node_installed()

  • khoros.core.Khoros.Studio.get_node_version()

  • khoros.core.Khoros.Studio.npm_installed()

  • khoros.core.Khoros.Studio.get_npm_version()

• Added the khoros.core.Khoros._import_studio_class() function and associated function call.

Supporting Modules

Additions to the supporting modules.

• Added the khoros.utils.core_utils.run_cmd() function.

• Added the khoros.utils.core_utils.decode_binary() function.

Documentation

Additions to the documentation.

• Added the khoros.core.Khoros.Board subclass to the primary modules page.

• Added the khoros.studio module to the primary modules page.

Changed

Documentation

Changes to the documentation.

• Swapped the Objects Module (khoros.objects) section with the Structures Module (khoros.structures) section on the primary modules page.

Return to Top

---

v2.5.0

Release Date: 2020-05-18

Added

Primary Modules

Additions to the primary modules.

• Added the following functions to the khoros.api module:

  • khoros.api.make_v1_request()

  • khoros.api.encode_v1_query_string()

  • khoros.api.deliver_v2_results()

  • khoros.api.parse_v2_response()

  • khoros.api._api_request_without_payload()

  • khoros.api._report_failed_attempt()

  • khoros.api._raise_exception_for_repeated_timeouts()

  • khoros.api._attempt_json_conversion()

• Added the following functions to the khoros.objects.users module:

  • khoros.objects.users.structure_user_dict_list()

  • khoros.objects.users.get_ids_from_login_list()

• Added the new khoros.structures.boards module with the following functions:

  • khoros.structures.boards.create()

  • khoros.structures.boards.structure_payload()

  • khoros.structures.boards._structure_id_and_title()

  • khoros.structures.boards._structure_discussion_style()

  • khoros.structures.boards._structure_parent_category()

  • khoros.structures.boards._structure_simple_fields()

  • khoros.structures.boards._structure_label_settings()

  • khoros.structures.boards._structure_blog_settings()

  • khoros.structures.boards._structure_contest_settings()

  • khoros.structures.boards._warn_about_ignored_settings()

• Added the khoros.structures.categories.create() function.

• Added khoros.core.Khoros.Category.create() method.

• Added the khoros.core.Khoros.User.get_ids_from_login_list() method.

• Added the khoros.core.Khoros.Board class with the khoros.core.Khoros.Board.create() method.

• Added the khoros.core.Khoros._import_board_class() method and accompanying method call.

Supporting Modules

Additions to the supporting modules.

• Added the khoros.utils.core_utils.convert_dict_id_values_to_strings() function.

• Added the khoros.utils.core_utils.extract_key_values_from_dict_list() function.

• Added the khoros.utils.core_utils.convert_list_values() function.

• Added the khoros.utils.tests.test_core_utils module with the following functions:

  • khoros.utils.tests.test_core_utils.set_package_path()

  • khoros.utils.tests.test_core_utils.import_core_utils()

  • khoros.utils.tests.test_core_utils.test_url_encoding()

  • khoros.utils.tests.test_core_utils.test_query_string_encoding()

  • khoros.utils.tests.test_core_utils.test_numeric_eval()

  • khoros.utils.tests.test_core_utils.test_convert_set()

  • khoros.utils.tests.test_core_utils._check_type_and_items()

Documentation

Additions to the documentation.

• Added the khoros.structures.boards module to the primary modules page.

• Added the khoros.utils.tests.test_core_utils module to the supporting modules page.

• Added a docstring to the khoros.api._get_json_query_string() function.

Changed

Primary Modules

Changes to the primary modules.

• Updated the khoros.api.post_request_with_retries(), khoros.api.put_request_with_retries() and khoros.api._api_request_with_payload() functions to perform the API requests even if no JSON payload is provided, and to leverage the new khoros.api._report_failed_attempt() and khoros.api._raise_exception_for_repeated_timeouts() functions.

• Updated the khoros.api.get_request_with_retries() function to leverage the new khoros.api._report_failed_attempt() and khoros.api._raise_exception_for_repeated_timeouts() functions.

• Updated the khoros.api.get_request_with_retries(), khoros.api.post_request_with_retries() and khoros.api.put_request_with_retries() functions to utilize the khoros.api._attempt_json_conversion() function.

• Updated the khoros.objects.messages.create() to leverage the khoros.api.parse_v2_response() function.

• Added the khoros.structures.boards module to the __all__ special variable in the khoros.structures (i.e. __init__.py) module and imported it by default.

Deprecated

Primary Modules

Deprecations in the primary modules.

• Deprecated the khoros.core.Khoros.Message.parse_v2_response() function as it was replaced with the khoros.core.Khoros.parse_v2_response() function which is a bit more generalized.

• Deprecated the khoros.objects.messages.parse_v2_response() function as it was replaced with the khoros.api.parse_v2_response() function which is a bit more generalized.

Return to Top

---

v2.4.0

Release Date: 2020-05-11

Added

Primary Modules

Additions to the primary modules.

• Added the following functions to the khoros.objects.messages module:

  • khoros.objects.messages.format_user_mention()

  • khoros.objects.messages._get_required_user_mention_data()

• Added the khoros.objects.roles module with the following functions:

  • khoros.objects.roles.get_total_role_count()

  • khoros.objects.roles.count_role_types()

  • khoros.objects.roles.get_roles_for_user()

• Added the khoros.objects.messages.MESSAGE_SEO_URLS dictionary constant.

• Added the following methods to the khoros.core.Khoros class:

  • khoros.core.Khoros.Message.format_content_mention()

  • khoros.core.Khoros.Message.format_user_mention()

• Added the from . import roles statement to the khoros.objects module and added roles to the __all__ special variable.

• Added the khoros.core.Khoros.Role inner class with the following methods:

  • khoros.core.Khoros.Role.get_total_role_count()

  • khoros.core.Khoros.Role.get_total_role_count()

• Added the method khoros.core.Khoros._import_role_class() to the core object and added the method call in the initialization method.

Supporting Modules

Additions to the supporting modules.

• Added the following exception classes:

  • khoros.errors.exceptions.MessageTypeNotFoundError

  • khoros.errors.exceptions.InvalidRoleError

  • khoros.errors.exceptions.InvalidRoleTypeError

• Added the khoros.utils.tests.test_mentions unit test module.

Documentation

Additions to the documentation.

• Added khoros.utils.tests.test_mentions to the Support Modules page.

• Added khoros.objects.roles to the primary modules page.

• Added khoros.core.Khoros.Role to the primary modules page.

• Added a code coverage badge to the README.md file.

General

• Added a code coverage section to the pythonpackage.yml file.

• Added the codecov.yml file for coverage reports.

Changed

General

• Changed the PyPI Development Status in setup.py to be Development Status :: 4 - Beta.

Fixed

Primary Modules

Fixes to the primary modules.

• Fixed how and when values are cast to integers in khoros.objects.users._get_user_identifier().

• Added missing method calls for the khoros.core.Khoros._import_message_class() and khoros.core.Khoros._import_album_class() methods in the initialization method for the khoros.core.Khoros class.

Return to Top

---

v2.3.0

Release Date: 2020-05-08

Added

Primary Modules

Additions to the primary modules.

• Added the khoros.api.encode_multipart_data() function.

• Added the following functions to the khoros.objects.messages module:

  • khoros.objects.messages.create()

  • khoros.objects.messages.construct_payload()

  • khoros.objects.messages._verify_required_fields()

  • khoros.objects.messages.parse_v2_response()

  • khoros.objects.messages._confirm_field_supplied()

• Created the khoros.objects.attachments module with the following functions:

  • khoros.objects.attachments.construct_multipart_payload()

  • khoros.objects.attachments.format_attachment_payload()

  • khoros.objects.attachments.get_list_items()

  • khoros.objects.attachments.get_file_upload_info()

  • khoros.objects.attachments._format_single_file()

  • khoros.objects.attachments._format_multiple_files()

• Created the khoros.objects.albums module with the following functions:

  • khoros.objects.albums.create()

  • khoros.objects.albums.format_album_json()

  • khoros.objects.albums.get_albums_for_user()

  • khoros.objects.albums._null_to_blank()

• Added the following methods to the khoros.core.Khoros class:

  • khoros.core.Khoros._import_album_class()

  • khoros.core.Khoros._import_message_class()

• Added the khoros.core.Khoros.Album inner class with the following methods:

  • khoros.core.Khoros.Album.create()

  • khoros.core.Khoros.Album.get_albums_for_user()

• Added the khoros.core.Khoros.Message inner class with the following methods:

  • khoros.core.Khoros.Message.create()

  • khoros.core.Khoros.Message.parse_v2_response()

• Added an import statement for khoros.objects.albums to the khoros.objects module.

Supporting Modules

Additions to the supporting modules.

• Added the khoros.utils.core_utils.convert_single_value_to_tuple() function.

• Added the khoros.utils.core_utils.convert_string_to_tuple() function.

• Added the khoros.utils.core_utils.is_numeric() function.

• Added the khoros.errors.exceptions.DataMismatchError exception class.

Documentation

Additions to the documentation.

• Added the Utilizing environment variables section to the Introduction page.

• Updated the README.md file to match the Introduction page.

• Added the khoros.objects.messages module to the primary modules page.

• Added the khoros.objects.albums module to the primary modules page.

• Added the khoros.objects.attachments module to the primary modules page.

• Added the khoros.core.Khoros.Album class to the primary modules page.

• Added the khoros.core.Khoros.Message class to the primary modules page.

• Added the SECURITY.md and CODE_OF_CONDUCT.md files to the source repository.

General

• Added requests-toolbelt==0.9.1 to the requirements.txt file.

Changed

Primary Modules

Changes to the primary modules.

• Updated the khoros.core.Khoros class so that environment variables are ignored if a Helper configuration file is supplied when instantiating the core object.

• Added the ability to perform multipart/form-data API calls in functions below.

  • khoros.api.post_request_with_retries()

  • khoros.api.put_request_with_retries()

  • khoros.api._api_request_with_payload()

• Added the associated exception type (e.g. ValueError) to the failure messages in khoros.api.get_request_with_retries() and khoros.api._api_request_with_payload().

• Updated the khoros.api.get_request_with_retries() to use the khoros.errors.exceptions.APIConnectionError exception class rather than ConnectionError.

• Updated the khoros.api.get_request_with_retries() and khoros.api._api_request_with_payload() functions to only retry if relevant exception classes are raised in the try/except.

• Added functionality to khoros.api.post_request_with_retries() and khoros.api.put_request_with_retries() to display an error but still return the API response if unable to convert the response to JSON format when requested.

• Renamed the khoros.api.__api_request_with_payload() function to be khoros.api._api_request_with_payload() instead.

• Replaced print() statements in the khoros.api.get_request_with_retries() and khoros.api._api_request_with_payload() functions with khoros.errors.handlers.eprint() function calls.

• Added the multipart Boolean argument to the khoros.api.define_headers() which will remove the Content-Type header key and value if the API call is for a multipart/form-data query.

• Added the allow_exceptions argument (True by default) to the khoros.liql.perform_query() function to allow the khoros.errors.exceptions.GETRequestError exception to be disabled if an error response is returned.

• Updated the error/exception message in the khoros.liql.perform_query() to be more specific.

Documentation

Changes to the documentation.

• Added a full docstring to the khoros.api._api_request_with_payload() function.

Fixed

Primary Modules

Fixes to the primary modules.

• Removed the Aurea reference from the failure message in khoros.api._api_request_with_payload.

Supporting Modules

Fixes to the supporting modules.

• Changed “v1” to “v2” in the full error message string within the khoros.errors.handlers._get_v2_error_from_json() function.

Return to Top

---

v2.2.0

Release Date: 2020-04-26

Added

Primary Modules

Additions to the primary modules.

• Added the ability to use environmental variables to initialize the khoros.core.Khoros object.

  • Added the khoros.core.Khoros._parse_env_settings() method to parse the environmental variables.

• Added the khoros.core.Khoros._session_auth_credentials_defined() method to automatically set the auth_type value in the _settings attribute to be session_auth if a session authentication username and password have been defined.

Supporting Modules

Additions to the supporting modules.

• Added the khoros.utils.environment module with the following functions and constants:

  • khoros.utils.environment.get_env_variables()

  • khoros.utils.environment._env_variable_exists()

  • khoros.utils.environment._get_env_variable_value()

  • khoros.utils.environment.update_env_variable_names()

  • khoros.utils.environment._update_env_list()

  • khoros.utils.environment._update_env_mapping()

  • khoros.utils.environment._import_custom_names_file()

  • khoros.utils.environment.ENV_VARIABLE_NAMES

• Added the khoros.utils.core_utils.get_file_type() function.

• Added the khoros.errors.exceptions.UnknownFileTypeError exception class.

• Added the khoros.utils.tests.test_helper_file unit test module.

Examples

New additions to the example files for the library.

• Added the custom_env_variables.json file.

• Added the custom_env_variables.yml file.

Documentation

Additions to the documentation.

• Added the khoros.utils.environment module to the supporting modules page.

• Added the khoros.utils.tests.test_helper_file module to the supporting modules page.

General

• Added the encrypted YAML Helper configuration file khoros_helper.yml.gpg in the khoros/utils/tests/ directory for use with pytest.

• Added the shell script decrypt_helper.sh in the .github/scripts/ directory per GitHub guidelines.

• Updated the pythonpackage.yml workflow for GitHub Actions to decrypt the helper configuration file (YAML) and utilize environment variables.

Changed

Primary Modules

Changes to the primary modules.

• Made an adjustment to the khoros.core.Khoros object class so that any values explicitly passed via the settings argument will overwrite any existing settings defined by default values and/or environmental variables.

• Added khoros.structures.base to the __all__ special variable in khoros.structures.

• Added khoros.objects.messages to the __all__ special variable in khoros.objects and added an import statement to import the module by default.

• Removed khoros.objects.base from the __all__ special variable in khoros.objects and removed the import statement to prevent the module from being imported by default.

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.

• Introduced support for JSON formatted helper configuration files in khoros.utils.helper.

• Removed the extra preceding underscore in private functions within khoros.utils.helper.

Documentation

Changes to the documentation.

• Added :special-members: __init__ to the khoros and khoros.core modules to display the docstrings for the __init__ method in the khoros.core.Khoros object class.

• Replaced NoneType with None in function and method docstrings to use proper syntax and to comply with PEP 287.

Return to Top

---

v2.1.0

Release Date: 2020-04-23

Added

Primary Modules

Additions to the primary modules.

• Added the khoros.liql.get_total_count() function.

• Added the khoros.core.Khoros.get_total_count() method within the core Khoros object.

• Added the khoros.structures module.

• Added the khoros.structures.base module with the following functions and class:

  • khoros.structures.base.get_details()

  • khoros.structures.base._check_url_for_identifier()

  • khoros.structures.base.get_structure_field()

  • khoros.structures.base.is_category_url()

  • khoros.structures.base.is_node_url()

  • khoros.structures.base.verify_structure_type()

  • khoros.structures.base.get_structure_type_from_url()

  • khoros.structures.base.Mapping

• Added the khoros.structures.categories module with the following functions:

  • khoros.structures.categories.get_category_id()

  • khoros.structures.categories.get_total_category_count()

  • khoros.structures.categories.get_category_details()

  • khoros.structures.categories.get_category_field()

  • khoros.structures.categories.get_url()

  • khoros.structures.categories.get_title()

  • khoros.structures.categories.get_description()

  • khoros.structures.categories.get_parent_type()

  • khoros.structures.categories.get_parent_id()

  • khoros.structures.categories.get_parent_url()

  • khoros.structures.categories.get_root_type()

  • khoros.structures.categories.get_root_id()

  • khoros.structures.categories.get_root_url()

  • khoros.structures.categories.get_language()

  • khoros.structures.categories.is_hidden()

  • khoros.structures.categories.get_views()

  • khoros.structures.categories.friendly_date_enabled()

  • khoros.structures.categories.get_friendly_date_max_age()

  • khoros.structures.categories.get_active_skin()

  • khoros.structures.categories.get_depth()

  • khoros.structures.categories.get_position()

  • khoros.structures.categories.get_creation_date()

• Added the khoros.structures.communities module with the following functions:

  • khoros.structures.communities.get_community_details()

  • khoros.structures.communities._check_for_multiple_tenants()

  • khoros.structures.communities.get_community_field()

  • khoros.structures.communities.get_tenant_id()

  • khoros.structures.communities.get_title()

  • khoros.structures.communities.get_description()

  • khoros.structures.communities.get_primary_url()

  • khoros.structures.communities.get_max_attachments()

  • khoros.structures.communities.get_permitted_attachment_types()

  • khoros.structures.communities.email_confirmation_required_to_post()

  • khoros.structures.communities.get_language()

  • khoros.structures.communities.get_ooyala_player_branding_id()

  • khoros.structures.communities.get_date_pattern()

  • khoros.structures.communities.friendly_date_enabled()

  • khoros.structures.communities.get_friendly_date_max_age()

  • khoros.structures.communities.get_active_skin()

  • khoros.structures.communities.get_sign_out_url()

  • khoros.structures.communities.get_creation_date()

  • khoros.structures.communities.top_level_categories_enabled()

  • khoros.structures.communities.show_community_node_in_breadcrumb()

  • khoros.structures.communities.show_breadcrumb_at_top_level()

  • khoros.structures.communities.top_level_categories_on_community_page()

• Added the khoros.structures.nodes module with the following functions and classes:

  • khoros.structures.nodes.get_node_id()

  • khoros.structures.nodes.get_node_type_from_url()

  • khoros.structures.nodes._get_node_type_identifier()

  • khoros.structures.nodes.get_total_node_count()

  • khoros.structures.nodes.get_node_details()

  • khoros.structures.nodes.get_node_field()

  • khoros.structures.nodes.get_url()

  • khoros.structures.nodes.get_type()

  • khoros.structures.nodes.get_discussion_style()

  • khoros.structures.nodes.get_title()

  • khoros.structures.nodes.get_description()

  • khoros.structures.nodes.get_parent_type()

  • khoros.structures.nodes.get_parent_id()

  • khoros.structures.nodes.get_parent_url()

  • khoros.structures.nodes.get_root_type()

  • khoros.structures.nodes.get_root_id()

  • khoros.structures.nodes.get_root_url()

  • khoros.structures.nodes.get_avatar_url()

  • khoros.structures.nodes.get_creation_date()

  • khoros.structures.nodes.get_depth()

  • khoros.structures.nodes.get_position()

  • khoros.structures.nodes.is_hidden()

  • khoros.structures.nodes.get_views()

  • khoros.structures.nodes.Mapping

• Added the khoros.core.Khoros.Category inner class with the following methods:

  • khoros.core.Khoros.Category.get_category_id()

  • khoros.core.Khoros.Category.get_total_category_count()

  • khoros.core.Khoros.Category.get_category_details()

  • khoros.core.Khoros.Category.get_category_field()

  • khoros.core.Khoros.Category.get_url()

  • khoros.core.Khoros.Category.get_title()

  • khoros.core.Khoros.Category.get_description()

  • khoros.core.Khoros.Category.get_parent_type()

  • khoros.core.Khoros.Category.get_parent_id()

  • khoros.core.Khoros.Category.get_parent_url()

  • khoros.core.Khoros.Category.get_root_type()

  • khoros.core.Khoros.Category.get_root_id()

  • khoros.core.Khoros.Category.get_root_url()

  • khoros.core.Khoros.Category.get_language()

  • khoros.core.Khoros.Category.is_hidden()

  • khoros.core.Khoros.Category.get_views()

  • khoros.core.Khoros.Category.friendly_date_enabled()

  • khoros.core.Khoros.Category.get_friendly_date_max_age()

  • khoros.core.Khoros.Category.get_active_skin()

  • khoros.core.Khoros.Category.get_depth()

  • khoros.core.Khoros.Category.get_position()

  • khoros.core.Khoros.Category.get_creation_date()

• Added the khoros.core.Khoros.Community inner class with the following methods:

  • khoros.core.Khoros.Community.get_community_details()

  • khoros.core.Khoros.Community.get_tenant_id()

  • khoros.core.Khoros.Community.get_title()

  • khoros.core.Khoros.Community.get_description()

  • khoros.core.Khoros.Community.get_primary_url()

  • khoros.core.Khoros.Community.get_max_attachments()

  • khoros.core.Khoros.Community.get_permitted_attachment_types()

  • khoros.core.Khoros.Community.email_confirmation_required_to_post()

  • khoros.core.Khoros.Community.get_language()

  • khoros.core.Khoros.Community.get_ooyala_player_branding_id()

  • khoros.core.Khoros.Community.get_date_pattern()

  • khoros.core.Khoros.Community.friendly_date_enabled()

  • khoros.core.Khoros.Community.get_friendly_date_max_age()

  • khoros.core.Khoros.Community.get_active_skin()

  • khoros.core.Khoros.Community.get_sign_out_url()

  • khoros.core.Khoros.Community.get_creation_date()

  • khoros.core.Khoros.Community.top_level_categories_enabled()

  • khoros.core.Khoros.Community.show_community_node_in_breadcrumb()

  • khoros.core.Khoros.Community.show_breadcrumb_at_top_level()

  • khoros.core.Khoros.Community.top_level_categories_on_community_page()

• Added the following methods to the khoros.core.Khoros.Node inner class:

  • khoros.core.Khoros.Node.get_total_node_count()

  • khoros.core.Khoros.Node.get_node_details()

  • khoros.core.Khoros.Node.get_node_field()

  • khoros.core.Khoros.Node.get_url()

  • khoros.core.Khoros.Node.get_type()

  • khoros.core.Khoros.Node.get_discussion_style()

  • khoros.core.Khoros.Node.get_title()

  • khoros.core.Khoros.Node.get_description()

  • khoros.core.Khoros.Node.get_parent_type()

  • khoros.core.Khoros.Node.get_parent_id()

  • khoros.core.Khoros.Node.get_parent_url()

  • khoros.core.Khoros.Node.get_root_type()

  • khoros.core.Khoros.Node.get_root_id()

  • khoros.core.Khoros.Node.get_root_url()

  • khoros.core.Khoros.Node.get_avatar_url()

  • khoros.core.Khoros.Node.get_creation_date()

  • khoros.core.Khoros.Node.get_depth()

  • khoros.core.Khoros.Node.get_position()

  • khoros.core.Khoros.Node.is_hidden()

  • khoros.core.Khoros.Node.get_views()

• Added the khoros.core.Khoros._import_category_class() method and accompanying method call.

• Added the khoros.core.Khoros._import_community_class() method and accompanying method call.

• Added the khoros.liql.COLLECTIONS constant.

Supporting Modules

Additions to the supporting modules.

• Added the khoros.utils.core_utils.display_warning() function.

• Added the following exception classes:

  • khoros.errors.exceptions.InvalidFieldError

  • khoros.errors.exceptions.InvalidStructureTypeError

  • khoros.errors.exceptions.InvalidURLError

Documentation

Additions to the documentation.

• Added the khoros.structures module and its submodules to the primary modules page.

Changed

Primary Modules

Changes to the primary modules.

• Updated the khoros.objects to import all submodules by default.

• Moved the khoros.objects.base.get_node_id() function to the khoros.structures.nodes module and added a DeprecationWarning.

• Moved the khoros.objects.base.get_node_type_from_url() function to the khoros.structures.nodes module and added a DeprecationWarning.

• Moved the khoros.objects.base.__get_node_type_identifier() function to the khoros.structures.nodes module and added a DeprecationWarning.

• Moved the khoros.objects.base.Mapping class to the khoros.structures.nodes module and added a DeprecationWarning.

• Added the khoros.structures.nodes.Mapping.avatar_size_mapping dictionary.

Fixed

Primary Modules

Fixes to the primary modules.

• Removed some print debugging that hadn’t been removed in the khoros.api.query_successful() function.

Documentation

Fixes to the documentation.

• Fixed the module name in the header docstring for the khoros.objects module.

• Fixed a typo in the docstring for the khoros.objects.users.query_users_table_by_id() function.

Supporting Modules

Additions to the supporting modules.

• Fixed the khoros.utils.tests.test_node_id_extract to use the new khoros.structures.nodes module.

Return to Top

---

v2.0.0

Release Date: 2020-04-10

Added

Primary Modules

Additions to the primary modules.

• Added the khoros.core.Khoros.perform_v1_search() method.

• Added the khoros.core.Khoros._import_node_class() and khoros.core.Khoros._import_user_class() methods within the core khoros.Khoros object class.

• Added the khoros.core.Khoros.Node inner class within the core khoros.Khoros object class.

• Added the static methods below within the core khoros.core.Khoros object class:

  • khoros.core.Khoros.Node.get_node_id()

  • khoros.core.Khoros.Node.get_node_type_from_url()

• Added the khoros.core.Khoros.User inner class within the core khoros.Khoros object class.

• Added the methods below within the core khoros.core.Khoros object class:

  • khoros.core.Khoros.User.create()

  • khoros.core.Khoros.User.delete()

  • khoros.core.Khoros.User.get_user_id()

  • khoros.core.Khoros.User.get_username()

  • khoros.core.Khoros.User.get_login()

  • khoros.core.Khoros.User.get_email()

  • khoros.core.Khoros.User.query_users_table_by_id()

  • khoros.core.Khoros.User.get_user_data()

  • khoros.core.Khoros.User.get_album_count()

  • khoros.core.Khoros.User.get_followers_count()

  • khoros.core.Khoros.User.get_following_count()

  • khoros.core.Khoros.User.get_images_count()

  • khoros.core.Khoros.User.get_public_images_count()

  • khoros.core.Khoros.User.get_messages_count()

  • khoros.core.Khoros.User.get_roles_count()

  • khoros.core.Khoros.User.get_solutions_authored_count()

  • khoros.core.Khoros.User.get_topics_count()

  • khoros.core.Khoros.User.get_replies_count()

  • khoros.core.Khoros.User.get_videos_count()

  • khoros.core.Khoros.User.get_kudos_given_count()

  • khoros.core.Khoros.User.get_kudos_received_count()

  • khoros.core.Khoros.User.get_online_user_count()

  • khoros.core.Khoros.User.get_registration_data()

  • khoros.core.Khoros.User.get_registration_timestamp()

  • khoros.core.Khoros.User.get_registration_status()

  • khoros.core.Khoros.User.get_last_visit_timestamp()

• Added the khoros.api.query_successful() function.

• Added the khoros.api.get_results_count() function.

• Added the khoros.api.get_items_list() function.

• Added the khoros.api.perform_v1_search() function.

• Added the khoros.api.delete() function.

• Added the new khoros.objects module to contain sub-modules for the various API objects.

• Added the khoros.objects.base module with the following functions and classes:

  • khoros.objects.base.get_node_id()

  • khoros.objects.base.get_node_type_from_url()

  • khoros.objects.base.__get_node_type_identifier()

  • khoros.objects.base.Mapping

• Added the khoros.objects.users module with the following functions:

  • khoros.objects.users.create()

  • khoros.objects.users.process_user_settings()

  • khoros.objects.users.structure_payload()

  • khoros.objects.users.delete()

  • khoros.objects.users.get_user_id()

  • khoros.objects.users.get_username()

  • khoros.objects.users.get_login()

  • khoros.objects.users.get_email()

  • khoros.objects.users.get_user_data_with_v1()

  • khoros.objects.users._get_where_clause_for_user_id()

  • khoros.objects.users._get_where_clause_for_username()

  • khoros.objects.users._get_where_clause_for_email()

  • khoros.objects.users._get_user_identifier()

  • khoros.objects.users.query_users_table_by_id()

  • khoros.objects.users._get_count()

  • khoros.objects.users._get_sum_weight()

  • khoros.objects.users.get_user_data()

  • khoros.objects.users.get_album_count()

  • khoros.objects.users.get_followers_count()

  • khoros.objects.users.get_following_count()

  • khoros.objects.users.get_images_count()

  • khoros.objects.users.get_public_images_count()

  • khoros.objects.users.get_messages_count()

  • khoros.objects.users.get_replies_count()

  • khoros.objects.users.get_roles_count()

  • khoros.objects.users.get_solutions_authored_count()

  • khoros.objects.users.get_topics_count()

  • khoros.objects.users.get_videos_count()

  • khoros.objects.users.get_kudos_given_count()

  • khoros.objects.users.get_kudos_received_count()

  • khoros.objects.users.get_online_user_count()

  • khoros.objects.users.get_registration_data()

  • khoros.objects.users.get_registration_timestamp()

  • khoros.objects.users.get_registration_status()

  • khoros.objects.users.get_last_visit_timestamp()

Supporting Modules

Additions to the supporting modules.

• Added the khoros.utils.core_utils.decode_html_entities() function.

• Added the following exception classes:

  • khoros.errors.exceptions.APIRequestError

  • khoros.errors.exceptions.DELETERequestError

  • khoros.errors.exceptions.InvalidNodeTypeError

  • khoros.errors.exceptions.MissingRequiredDataError

  • khoros.errors.exceptions.NodeIDNotFoundError

  • khoros.errors.exceptions.NodeTypeNotFoundError

  • khoros.errors.exceptions.TooManyResultsError

  • khoros.errors.exceptions.UserCreationError

• Added the following functions to the khoros.errors.handlers module.

  • khoros.errors.handlers.get_error_from_xml()

  • khoros.errors.handlers.get_error_from_json()

  • khoros.errors.handlers._get_v1_error_from_json()

  • khoros.errors.handlers._get_v2_error_from_json()

  • khoros.errors.handlers.verify_v1_response()

  • khoros.errors.handlers._import_exception_classes()

  • khoros.errors.handlers._exceptions_module_imported()

  • khoros.errors.handlers._import_exceptions_module()

• Added the khoros.utils.tests.test_node_id_extract module with the following functions:

  • khoros.utils.tests.test_node_id_extract.set_package_path()

  • khoros.utils.tests.test_node_id_extract.get_test_data()

  • khoros.utils.tests.test_node_id_extract.test_with_valid_node_types()

  • khoros.utils.tests.test_node_id_extract.test_with_invalid_node_types()

  • khoros.utils.tests.test_node_id_extract.test_with_only_url()

  • khoros.utils.tests.test_node_id_extract.test_url_without_node()

Documentation

Additions to the documentation.

• Added the Core Object Subclasses to the primary modules page.

• Added the khoros.objects module and the khoros.objects.base and khoros.objects.users sub-modules to the primary modules page.

• Added the khoros.utils.tests.test_node_id_extract module to the supporting modules page.

General

• Added PyCharm Python Security Scanner to the pythonpackage.yml file.

Changed

Primary Modules

Changes to the primary modules.

• Updated the khoros.liql.perform_query() function to allow a raw LiQL query to be passed rather than only pre-formatted query URLs.

• Updated the khoros.liql.perform_query() function to include an optional verify_success argument which verifies that the API query was successful and raises the khoros.errors.exceptions.GETRequestError exception if not.

• Removed the unnecessary import requests line in the khoros.liql module.

• Renamed the khoros.core.Khoros.__connect_with_session_key() method to be khoros.core.Khoros._connect_with_session_key() (single underscore prefix) instead.

• Renamed the khoros.core.Khoros.__define_url_settings() method to be khoros.core.Khoros._define_url_settings() (single underscore prefix) instead.

• Renamed the khoros.core.Khoros.__parse_helper_settings() method to be khoros.core.Khoros._parse_helper_settings() (single underscore prefix) instead.

• Renamed the khoros.core.Khoros.__populate_auth_settings() method to be khoros.core.Khoros._populate_auth_settings() (single underscore prefix) instead.

• Renamed the khoros.core.Khoros.__populate_construct_settings() method to be khoros.core.Khoros._populate_construct_settings() (single underscore prefix) instead.

• Renamed the khoros.core.Khoros.__populate_core_settings() method to be khoros.core.Khoros._populate_core_settings() (single underscore prefix) instead.

• Renamed the khoros.core.Khoros.__validate_base_url() method to be khoros.core.Khoros._validate_base_url() (single underscore prefix) instead.

Supporting Modules

Changes to the supporting modules.

• Updated the khoros.errors.exceptions.CurrentlyUnsupportedError exception class to allow the respective feature to be passed as a string argument for it to be explicitly referenced in the exception message.

• Updated the khoros.errors.handlers.get_error_from_html() function to have a second v1 argument, which is False by default.

Documentation

Changes to the documentation.

• Updated the docstring in khoros.api.query_successful() indicating the API response should be in JSON format.

General

• Changed the Development Status in setup.py to be 3 - Alpha.

Fixed

Primary Modules

Fixes in the primary modules.

• Updated the khoros.liql.format_query() function to properly encode the double-quote (") character and several other special characters.

Documentation

Fixes in the documentation.

• Fixed two bad hyperlinks in the README.md file.

• Fixed the docstrings in the khoros.errors.exceptions.InvalidOperatorError exception class to be accurate.

• Fixed the docstrings in the khoros.errors.exceptions.OperatorMismatchError exception class to be accurate.

Return to Top

---

v1.2.0

Release Date: 2020-03-22

Added

Primary Modules

Additions to the primary modules.

• Added the khoros.core.Khoros.signout() method.

• Added the khoros.auth.get_oauth_authorization_url() function.

• Added the khoros.auth.get_oauth_callback_url_from_user() function.

• Added the khoros.auth.invalidate_session() function.

• Added the khoros.api module with the following functions:

  • khoros.api.define_headers()

  • khoros.api.get_request_with_retries()

  • khoros.api.post_request_with_retries()

  • khoros.api.put_request_with_retries()

  • khoros.api.__api_request_with_payload()

Supporting Modules

Additions to the supporting modules.

• Added the khoros.utils.core_utils.get_random_string() function.

• Added the khoros.utils.core_utils.__structure_query_string() function.

• Added the following exception classes:

  • khoros.errors.exceptions.APIConnectionError

  • khoros.errors.exceptions.GETRequestError

  • khoros.errors.exceptions.InvalidCallbackURLError

  • khoros.errors.exceptions.InvalidEndpointError

  • khoros.errors.exceptions.InvalidLookupTypeError

  • khoros.errors.exceptions.InvalidRequestTypeError

  • khoros.errors.exceptions.LookupMismatchError

  • khoros.errors.exceptions.NotFoundResponseError

  • khoros.errors.exceptions.POSTRequestError

  • khoros.errors.exceptions.PUTRequestError

Documentation

Additions to the documentation.

• Added the khoros.api module to the primary modules page.

Changed

Primary Modules

Changes to the primary modules.

• Updated the core khoros.core.Khoros class to include the active Boolean flag in self.auth.

• Updated the khoros.liql.perform_query() function to utilize the khoros.api.get_request_with_retries() function.

• Made minor docstring adjustments to the khoros.liql.perform_query() function.

Supporting Modules

Changes to the supporting modules.

• Added the no_encode argument and associated functionality to the khoros.utils.core_utils.encode_query_string() function.

Return to Top

---

v1.1.0

Release Date: 2020-03-17

Added

Primary Modules

Additions to the primary modules.

• Added the khoros.utils.version.warn_when_not_latest() function call to the main khoros module.

Supporting Modules

Additions to the supporting modules.

• Added the khoros.utils.version.get_latest_stable() function.

• Added the khoros.utils.version.latest_version() function.

• Added the khoros.utils.version.warn_when_not_latest() function.

Documentation

Additions to the documentation.

• Added the Changelog and Usage sections to the README.md file.

• Created the Change Log page and populated it with the v1.1.0 changes.

• Created the primary modules and supporting modules pages.

Return to Top