Skip to content

Requirements

Chris Lunsford edited this page May 15, 2020 · 4 revisions

Functional

  • Wrap the Webex Teams API endpoints in Python-native functions; the functions must accept all required and optional API parameters as inputs and return the response objects as Python-native objects.
  • The library must provide Python-native data models for all documented API data models.
  • An SDK user must be able to create a connection object providing their authentication and session parameters at initialization.
  • Wrapped API endpoints must be exposed and hierarchically organized underneath the connection object.
  • The library must raise Python-native exceptions for all API errors.
  • The library must abstract and transparently handle API mechanics like pagination.
  • The library must provide support for automatic API rate-limit handling; users should be able to disable this feature.

Non-Functional

Usability

  • Users should install the Python package via PIP (pip install ___).
  • Users should have the ability to install pre-release versions.
  • The library's structure and code-base should facilitate IDE autocompletion.
  • Every user-facing function should have a descriptive docstring that documents the function's parameters and expected behavior.
  • The library should provide Quick Start documentation that walks the user through initial setup, use, standard operations, and essential features.
  • The library should provide complete library-API documentation with full coverage for all exposed classes, methods, and parameters. Ideally, these should be auto-generated from the source code.
Clone this wiki locally