timeback 0.1.0

A Python client for the TimeBack API (OneRoster 1.2 implementation)

Timeback

Python client for the Timeback API (OneRoster 1.2 plus adjacent services).

Installation

Using Poetry (recommended)

poetry install
poetry shell

From built wheel

poetry build
pip install dist/timeback-0.1.0-py3-none-any.whl

Configuration

Required environment variables:

• TIMEBACK_CLIENT_ID
• TIMEBACK_CLIENT_SECRET
• TIMEBACK_ENVIRONMENT in {production, staging}

Optional per-service base URL overrides:

• TIMEBACK_QTI_API_BASE_URL (defaults by environment)
• TIMEBACK_CALIPER_API_BASE_URL (defaults by environment)

Defaults by environment:

• production
  • OneRoster: https://api.alpha-1edtech.ai/
  • QTI: https://qti.alpha-1edtech.ai/api
  • Caliper: https://caliper.alpha-1edtech.ai
• staging
  • OneRoster: https://api.staging.alpha-1edtech.ai/
  • QTI: https://qti-staging.alpha-1edtech.ai/api
  • Caliper: https://caliper-staging.alpha-1edtech.ai

Quick start

from timeback import Timeback

client = Timeback()
user = client.oneroster.rostering.get_user("<sourcedId>")
print(user.sourcedId, user.givenName, user.familyName)

Override QTI/Caliper base URLs explicitly:

client = Timeback(
    environment="staging",
    qti_api_base_url="https://my-qti.example.com/api",
    caliper_api_base_url="https://my-caliper.example.com",
)

# Raw HTTP clients (services can be added later)
qti_health = client.qti_http.get("/health")
caliper_status = client.caliper_http.get("/status")

Services and endpoints

• OneRoster
  • client.oneroster.rostering.get_user(sourced_id, fields=None)

Design rules: service methods contain no business logic; each method calls a single endpoint function in timeback/services/.../endpoints/, which may import utilities from .../utils/. All endpoints/utilities return typed Pydantic models/enums from timeback/models and timeback/enums.

See docs for structure and procedures:

• timeback/docs/coding_guidelines.md
• timeback/docs/add_endpoint_procedure.md
• timeback/docs/oneroster/rostering/get_user.md

Testing

Run all unit tests:

poetry run pytest -q -m "not integration"

Run integration tests (real API calls; requires network and creds):

export TIMEBACK_ENVIRONMENT=production
export TIMEBACK_CLIENT_ID=...
export TIMEBACK_CLIENT_SECRET=...
poetry run pytest -q -m integration

Development

Formatting and linting:

poetry run black .
poetry run flake8 .
poetry run mypy .

Build and publish:

poetry build
poetry publish  # requires configured credentials