Skip to content

README.md

Latest commit

 

History

History
100 lines (71 loc) · 3.71 KB

README.md

File metadata and controls

100 lines (71 loc) · 3.71 KB

Open CU Services SDK for Python

The master branch does not store source code of SDKs, instead code is stored in the SDK branches and version tags:

  • latest SDK branch: python/{SDK_ID}, for example python/lmsapi
  • versioned SDK tag: python/{SDK_ID}/v{VERSION}, for example python/lmsapi/v0.1.0

Available SDKs

CU LMS API (lmsapi)

Latest Release Spec Debug Response Support

Python License

Installation

Install with pip

Install with pip:

pip install "open-cu-services-lmsapi @ git+https://github.com/cu-devs-collective/open-cu-services-sdk.git@python/lmsapi/v0.1.0#subdirectory=python/lmsapi"

Or add to requirements.txt:

open-cu-services-lmsapi @ git+https://github.com/cu-devs-collective/open-cu-services-sdk.git@python/lmsapi/v0.1.0#subdirectory=python/lmsapi

Install with package manager

Add the dependency to your pyproject.toml:

dependencies = [
  "open-cu-services-lmsapi @ git+https://github.com/cu-devs-collective/open-cu-services-sdk.git@python/lmsapi/v0.1.0#subdirectory=python/lmsapi"
]

When using a package manager like uv or poetry, you can define the source explicitly:

# uv
[tool.uv.sources]
open-cu-services-lmsapi = { git = "https://github.com/cu-devs-collective/open-cu-services-sdk", tag = "python/lmsapi/v0.1.0", subdirectory = "python/lmsapi" }

# poetry
[tool.poetry.dependencies]
open-cu-services-lmsapi = { git = "https://github.com/cu-devs-collective/open-cu-services-sdk", tag = "python/lmsapi/v0.1.0", subdirectory = "python/lmsapi" }

See examples/python for runnable examples.

Development

When working against a local checkout of a generated SDK branch or tag, add a local source override in your pyproject.toml. pip does not support dependency source overrides in pyproject.toml, instead use a package manager like uv or poetry:

# uv
[tool.uv.sources]
open-cu-services-lmsapi = { path = "../../python/lmsapi" }

# poetry
[tool.poetry.dependencies]
open-cu-services-lmsapi = { path = "../../python/lmsapi", develop = true }

For direct local testing with pip, install the generated package path into your virtual environment:

pip install -e ../../python/lmsapi

This override only works when the checked-out ref contains the generated package at python/lmsapi.

Reporting Issues

Please read Reporting Issues for Codegen Clients and use the Codegen client issue report template for codegen client issues.