################## Supporting Modules ################## This section provides details around the supporting modules used in the **khoros** package, which are listed below. * `Classes & Exceptions`_ * `Errors Module (khoros.errors)`_ * `Exceptions Module (khoros.errors.exceptions)`_ * `Handlers Module (khoros.errors.handlers)`_ * `Translations Module (khoros.errors.translations)`_ * `Tools & Utilities`_ * `Core Utilities Module (khoros.utils.core_utils)`_ * `Logging Utilities Module (khoros.utils.log_utils)`_ * `Environment Module (khoros.utils.environment)`_ * `Helper Module (khoros.utils.helper)`_ * `Version Module (khoros.utils.version)`_ * `Unit Testing`_ * `Tests Module (khoros.utils.tests)`_ * `Resources Module (khoros.utils.tests.resources)`_ * `Test Albums Module (khoros.utils.tests.test_albums)`_ * `Test Archives Module (khoros.utils.tests.test_archives)`_ * `Test Board Creation Module (khoros.utils.tests.test_board_creation)`_ * `Test Bulk Data Module (khoros.utils.tests.test_bulk_data)`_ * `Test Categories Module (khoros.utils.tests.test_categories)`_ * `Test Communities Module (khoros.utils.tests.test_communities)`_ * `Test Core Utilities Module (khoros.utils.tests.test_core_utils)`_ * `Test Error Handling Module (khoros.utils.tests.test_error_handling)`_ * `Test Exceptions Module (khoros.utils.tests.test_exceptions)`_ * `Test Group Hub Creation Module (khoros.utils.tests.test_grouphub_creation)`_ * `Test Helper File Module (khoros.utils.tests.test_helper_file)`_ * `Test HTTP Headers Module (khoros.utils.tests.test_http_headers)`_ * `Test Library Import Module (khoros.utils.tests.test_library_import)`_ * `Test LiQL Module (khoros.utils.tests.test_liql)`_ * `Test Mentions Module (khoros.utils.tests.test_mentions)`_ * `Test Messages Module (khoros.utils.tests.test_messages)`_ * `Test Node ID Extract Module (khoros.utils.tests.test_node_id_extract)`_ * `Test Roles Module (khoros.utils.tests.test_roles)`_ * `Test Settings Module (khoros.utils.tests.test_settings)`_ * `Test SSL Verification Module (khoros.utils.tests.test_ssl_verify)`_ * `Test Studio Module (khoros.utils.tests.test_studio)`_ * `Test Tags Module (khoros.utils.tests.test_tags)`_ * `Test Users Module (khoros.utils.tests.test_users)`_ * `Test Version Module (khoros.utils.tests.test_version)`_ | ******************** Classes & Exceptions ******************** This section includes modules that contain the classes and exceptions used throughout the package. | Errors Module (khoros.errors) ============================= This module contains all of the exception classes and error handling functions leveraged throughout the library. .. automodule:: khoros.errors :members: :doc:`Return to Top ` | Exceptions Module (khoros.errors.exceptions) -------------------------------------------- This sub-module contains all of the exception classes leveraged in functions throughout the library. .. automodule:: khoros.errors.exceptions :members: :doc:`Return to Top ` | Handlers Module (khoros.errors.handlers) ---------------------------------------- This sub-module contains various error handling functions that are leveraged throughout the library. .. automodule:: khoros.errors.handlers :members: :doc:`Return to Top ` | Translations Module (khoros.errors.translations) ------------------------------------------------ This sub-module provides more relevant translations for error messages in API responses where possible. .. automodule:: khoros.errors.translations :members: :doc:`Return to Top ` | ***************** Tools & Utilities ***************** This section includes modules that contain tools and utilities leveraged by other scripts. | Core Utilities Module (khoros.utils.core_utils) =============================================== This module includes various utilities to assist in converting dictionaries to JSON, formatting timestamps, etc. .. automodule:: khoros.utils.core_utils :members: :doc:`Return to Top ` | Logging Utilities Module (khoros.utils.log_utils) ================================================= This module includes various utilities to assist with logging. .. automodule:: khoros.utils.log_utils :members: :doc:`Return to Top ` | Environment Module (khoros.utils.environment) ============================================= This module identifies any environmental variables that have been defined for use within the :py:mod:`khoros` library. .. automodule:: khoros.utils.environment :members: :doc:`Return to Top ` | Helper Module (khoros.utils.helper) =================================== This module allows a "helper" configuration file to be imported and parsed to facilitate the use of the library (e.g. defining the base URL and API credentials) and defining additional settings. .. automodule:: khoros.utils.helper :members: :doc:`Return to Top ` | Version Module (khoros.utils.version) ===================================== This module is the primary source of the current version of the khoros package, and includes two simple functions to return either the full version or the major.minor (i.e. X.Y) version. .. automodule:: khoros.utils.version :members: :doc:`Return to Top ` | ************ Unit Testing ************ This section includes modules that are used in unit testing the library. | Tests Module (khoros.utils.tests) ================================= This module includes unit tests for the package that are performed using pytest. .. automodule:: khoros.utils.tests :members: :doc:`Return to Top ` | Resources Module (khoros.utils.tests.resources) ----------------------------------------------- This module includes frequently used resources for performing unit testing. .. automodule:: khoros.utils.tests.resources :members: :doc:`Return to Top ` | Test Albums Module (khoros.utils.tests.test_albums) --------------------------------------------------- This module is used by pytest to verify that the ``albums`` module works properly. .. automodule:: khoros.utils.tests.test_albums :members: :doc:`Return to Top ` | Test Archives Module (khoros.utils.tests.test_archives) ------------------------------------------------------- This module is used by pytest to verify that the ``archives`` module works properly. .. automodule:: khoros.utils.tests.test_archives :members: :doc:`Return to Top ` | Test Board Creation Module (khoros.utils.tests.test_board_creation) ------------------------------------------------------------------- This module is used by pytest to verify that the board creation works properly. .. automodule:: khoros.utils.tests.test_board_creation :members: :doc:`Return to Top ` | Test Bulk Data Module (khoros.utils.tests.test_bulk_data) --------------------------------------------------------- This module is used by pytest to verify that the Bulk Data API module works properly. .. automodule:: khoros.utils.tests.test_bulk_data :members: :doc:`Return to Top ` | Test Categories Module (khoros.utils.tests.test_categories) ----------------------------------------------------------- This module is used by pytest to verify that the ``categories`` module works properly. .. automodule:: khoros.utils.tests.test_categories :members: :doc:`Return to Top ` | Test Communities Module (khoros.utils.tests.test_communities) ------------------------------------------------------------- This module is used by pytest to verify that the ``communities`` module works properly. .. automodule:: khoros.utils.tests.test_communities :members: :doc:`Return to Top ` | Test Core Utilities Module (khoros.utils.tests.test_core_utils) --------------------------------------------------------------- This module is used by pytest to verify that the core package utilities work properly. .. automodule:: khoros.utils.tests.test_core_utils :members: :doc:`Return to Top ` | Test Error Handling Module (khoros.utils.tests.test_error_handling) ------------------------------------------------------------------- This module is used by pytest to verify that error handling works properly. .. automodule:: khoros.utils.tests.test_error_handling :members: :doc:`Return to Top ` | Test Exceptions Module (khoros.utils.tests.test_exceptions) ----------------------------------------------------------- This module is used by pytest to verify that exceptions are raised properly. .. automodule:: khoros.utils.tests.test_exceptions :members: :doc:`Return to Top ` | Test Group Hub Creation Module (khoros.utils.tests.test_grouphub_creation) -------------------------------------------------------------------------- This module is used by pytest to verify that the group hub creation works properly. .. automodule:: khoros.utils.tests.test_grouphub_creation :members: :doc:`Return to Top ` | Test Helper File Module (khoros.utils.tests.test_helper_file) ------------------------------------------------------------- This module is used by pytest to verify that the helper configuration files work properly. .. automodule:: khoros.utils.tests.test_helper_file :members: :doc:`Return to Top ` | Test HTTP Headers Module (khoros.utils.tests.test_http_headers) --------------------------------------------------------------- This module is used by pytest to verify that HTTP headers are formatted appropriately. .. automodule:: khoros.utils.tests.test_http_headers :members: :doc:`Return to Top ` | Test Library Import Module (khoros.utils.tests.test_library_import) ------------------------------------------------------------------- This module tests importing each of the primary modules in the library. .. automodule:: khoros.utils.tests.test_library_import :members: :doc:`Return to Top ` | Test LiQL Module (khoros.utils.tests.test_liql) ----------------------------------------------- This module tests parsing and/or executing LiQL queries. .. automodule:: khoros.utils.tests.test_liql :members: :doc:`Return to Top ` | Test Mentions Module (khoros.utils.tests.test_mentions) ------------------------------------------------------- This module is used by pytest to verify that user and content mentions work properly. .. automodule:: khoros.utils.tests.test_mentions :members: :doc:`Return to Top ` | Test Messages Module (khoros.utils.tests.test_messages) ------------------------------------------------------- This module is used by pytest to verify that messages work properly. .. automodule:: khoros.utils.tests.test_messages :members: :doc:`Return to Top ` | Test Node ID Extract Module (khoros.utils.tests.test_node_id_extract) --------------------------------------------------------------------- This module is used by pytest to verify that Node IDs can be extracted successfully from URLs. .. automodule:: khoros.utils.tests.test_node_id_extract :members: :doc:`Return to Top ` | Test Roles Module (khoros.utils.tests.test_roles) ------------------------------------------------- This module is used by pytest to verify that roles-related functions work properly. .. automodule:: khoros.utils.tests.test_roles :members: :doc:`Return to Top ` | Test Settings Module (khoros.utils.tests.test_settings) ------------------------------------------------------- This module is used by pytest to verify that settings can be retrieved and updated properly. .. automodule:: khoros.utils.tests.test_settings :members: :doc:`Return to Top ` | Test SSL Verification Module (khoros.utils.tests.test_ssl_verify) ----------------------------------------------------------------- This module is used by pytest to verify the SSL verification functionality. .. automodule:: khoros.utils.tests.test_ssl_verify :members: :doc:`Return to Top ` | Test Studio Module (khoros.utils.tests.test_studio) --------------------------------------------------- This module is used by pytest to verify that the ``studio`` module functions properly. .. automodule:: khoros.utils.tests.test_studio :members: :doc:`Return to Top ` | Test Tags Module (khoros.utils.tests.test_tags) ----------------------------------------------- This module is used by pytest to verify that tags function properly. .. automodule:: khoros.utils.tests.test_tags :members: :doc:`Return to Top ` | Test Users Module (khoros.utils.tests.test_users) ------------------------------------------------- This module is used by pytest to verify that the ``users`` module functions properly. .. automodule:: khoros.utils.tests.test_users :members: :doc:`Return to Top ` | Test Version Module (khoros.utils.tests.test_version) ----------------------------------------------------- This module is used by pytest to verify that the ``version`` module functions properly. .. automodule:: khoros.utils.tests.test_version :members: :doc:`Return to Top ` | The previous page addresses the :doc:`primary-modules` within the *khoros* package.