Skip to content

Python SDK: OrkesClients class name is confusing for OSS users — implies Orkes account required #45

@nthmost-orkes

Description

@nthmost-orkes

Summary

The primary client factory class in the Python SDK quickstart is named OrkesClients. For first-time OSS users, this name implies an Orkes account, Orkes Cloud, or paid Orkes service is required — which is not the case. The class works equally well with a self-hosted OSS Conductor server.

What new users see

The quickstart imports:

from conductor.client.orkes_clients import OrkesClients

clients = OrkesClients(configuration=config)
executor = clients.get_workflow_executor()

A new OSS user unfamiliar with the project history will reasonably ask:

  • "Do I need an Orkes account to use this?"
  • "Why does my open-source SDK depend on a class called OrkesClients?"
  • "Is there an OSSClients or ConductorClients alternative I should use instead?"

What OrkesClients actually is

It's a factory facade that instantiates implementations of the various client interfaces (workflow, metadata, task, scheduler, etc.). Internally it uses Orkes* implementations, but these work identically against OSS Conductor. There is no OSS-vs-Orkes distinction at the API level for core workflow functionality.

Why it matters

This is now the recommended first import in the official quickstart. Every OSS user who reads the quickstart will see this name and may hesitate or search for an "OSS" alternative that doesn't exist.

Expected fix

Either:

  1. Add a ConductorClients alias or subclass with a note: "OrkesClients is the standard client factory — the name reflects the implementing organization, not a requirement to use Orkes Cloud"
  2. Rename to ConductorClients (breaking change, but more accurate for an OSS SDK)
  3. Add a comment in the quickstart and README explaining why it's named OrkesClients and confirming it works with self-hosted OSS

Fix location

conductor-oss/python-sdk — README.md and/or src/conductor/client/orkes_clients.py

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: sdkAny language SDKdocumentationImprovements or additions to documentationfix: docs-onlyFix is a documentation/copy change, no code neededsdk: python

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions