Khoros JX Python Library

Welcome to the official documentation for the Khoros JX Python Library.

Table of Contents

• Introduction
  • Installation
  • Change Log
  • Basic Usage
    • Importing the package
    • Initializing the modules
    • Establishing the API connection
  • Requirements
  • Modules
  • License
  • Reporting Issues
  • Disclaimer
• Core Functionality
  • Getting Started
    • Importing the package
    • Initializing the modules
    • Establishing the API connection
  • Performing GET Requests
    • Using the get_data() function
      • Optional arguments in the get_data() function
        • Ignoring exceptions in the get_data() function
        • Returning the get_data() response in JSON format
    • Using the get_request_with_retries() function
      • Returning the get_request_with_retries() response in JSON format
  • Performing POST Requests
  • Performing PUT Requests
• Using the Helper Utility
  • What is a helper?
  • The configuration file
    • API Connection
      • Supplying credentials in the config file
      • Retrieving credentials using a script function
    • Script Styling
  • Initializing the Helper
    • Global Variables
• Managing Users
  • Leveraging the Users Module
  • Obtaining User Information
    • Obtain the User ID of a user
    • Obtain the username, email address and profile URL of a user
      • Obtain the username
      • Obtain the primary email address
      • Obtain the user profile URL
• Primary Modules
  • Init Module (khorosjx)
  • Core Module (khorosjx.core)
  • Admin Module (khorosjx.admin)
  • Content Module (khorosjx.content)
    • Base Content Module (khorosjx.content.base)
    • Documents Module (khorosjx.content.docs)
    • Events Module (khorosjx.content.events)
    • Ideas Module (khorosjx.content.ideas)
    • Threads Module (khorosjx.content.threads)
    • Videos Module (khorosjx.content.videos)
  • Groups Module (khorosjx.groups)
  • News Module (khorosjx.news)
  • Places Module (khorosjx.places)
    • Base Places Module (khorosjx.places.base)
    • Blogs Module (khorosjx.places.blogs)
    • Spaces Module (khorosjx.places.spaces)
  • Spaces Module (khorosjx.spaces)
  • Users Module (khorosjx.users)
• Supporting Modules
  • Tools and Utilities
    • Core Utilities Module (khorosjx.utils.core_utils)
    • Dataframe Utilities Module (khorosjx.utils.df_utils)
    • Helper Module (khorosjx.utils.helper)
    • Tests Module (khorosjx.utils.tests)
    • Version Module (khorosjx.utils.version)
  • Classes and Exceptions
    • Classes Module (khorosjx.utils.classes)
    • Errors Module (khorosjx.errors)
      • Exceptions Module (khorosjx.errors.exceptions)
      • Handlers Module (khorosjx.errors.handlers)

• Change Log
  • v3.2.0
    • Added
    • Changed
  • v3.1.0
    • Added
    • Changed
    • Fixed
  • v3.0.0
    • Added
    • Changed
    • Fixed
  • v2.5.3
    • Changed
    • Fixed
  • v2.5.2
    • Fixed
  • v2.5.1
    • Added
    • Changed
    • Fixed
  • v2.5.0
    • Changed
    • Fixed
  • v2.4.1
    • Fixed
  • v2.4.0
    • Added
    • Changed
    • Fixed
  • v2.3.1
    • Changed
  • v2.3.0
    • Added
    • Changed
    • Fixed
    • Removed
  • v2.2.0
    • Added
    • Changed
  • v2.1.0
    • Added
    • Changed
  • v2.0.0
    • Added
    • Changed
    • Fixed
    • Deprecated
    • Removed
  • v1.7.0
    • Added
    • Changed
    • Fixed
    • Deprecated
  • v1.6.0
    • Added
    • Changed
    • Fixed
  • v1.5.0
    • Added
    • Changed
    • Fixed
  • v1.4.0
    • Added
    • Changed
    • Removed
  • v1.3.0
    • Added
  • v1.2.0
    • Added
    • Changed
  • v1.1.1
    • Added
    • Changed
    • Removed
  • v1.1.0
    • Added
    • Changed
    • Deprecated
    • Fixed
  • v1.0.1.post1
    • Changed
  • v1.0.1
    • Changed
    • Fixed

• Roadmap

Module Index and Search

• Index

• Module Index

• Search Page