Skip to content

Python SDK README: venv example uses virtualenv (external package) instead of python3 -m venv (stdlib) #35

@nthmost-orkes

Description

@nthmost-orkes

Summary

The Python SDK README's venv setup example calls virtualenv, which is a third-party package requiring a separate installation (pip install virtualenv). The Python standard library has included venv since Python 3.3, and it is the canonical, recommended way to create virtual environments without any additional dependencies.

Current README

virtualenv conductor
source conductor/bin/activate
python3 -m pip install conductor-python

Running virtualenv conductor on a fresh system fails with:

bash: virtualenv: command not found

This sends the user on a detour to install virtualenv before they can even install the SDK.

Expected fix

python3 -m venv conductor-env
source conductor-env/bin/activate
pip install conductor-python

python3 -m venv works on any Python 3.3+ installation (which includes all versions the SDK claims to support) with no extra packages required.

Additional note

The activate path also differs between virtualenv-created envs and venv-created envs on some systems. Using stdlib venv avoids this inconsistency entirely.

Fix location

conductor-oss/python-sdk — README.md Installation section

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