Skip to content

refactor: reorganize SDK structure into sdks/ directory (sync/update-readme) - #10

Open
jumsay wants to merge 4 commits into
sync/update-readme-with-github-flowfrom
refactor/reorganize-sdks-structure-sync
Open

refactor: reorganize SDK structure into sdks/ directory (sync/update-readme)#10
jumsay wants to merge 4 commits into
sync/update-readme-with-github-flowfrom
refactor/reorganize-sdks-structure-sync

Conversation

@jumsay

@jumsay jumsay commented Jan 15, 2026

Copy link
Copy Markdown
Collaborator

🔄 Overview

This PR implements Option B of the SDK reorganization on the sync/update-readme-with-github-flow branch: moving both typescript-sdk/ and implementations/python/ into a new unified sdks/ directory.

📦 Changes

Structure Changes

Before:                          After:
typescript-sdk/          →       sdks/typescript/
implementations/python/  →       sdks/python/

Files Modified

  • 191 files moved (Python SDK)
  • 25 files moved (TypeScript SDK)
  • Documentation updated (11 files)
  • Docker configs updated (3 files)
  • New sdks/README.md with migration guide

🎯 Benefits

  1. Better organization: All SDK implementations grouped together
  2. Consistency: Both SDKs at the same hierarchy level
  3. Scalability: Easy to add new language SDKs (Go, Rust, etc.)
  4. Clarity: Clear separation between SDKs and other project components

⚠️ Breaking Change

IMPORTANT: This is a BREAKING CHANGE for users with local clones or CI/CD references.

Migration Path

For developers:

git pull origin sync/update-readme-with-github-flow
# Update any local scripts referencing old paths

For CI/CD pipelines:

  • Update working-directory from implementations/pythonsdks/python
  • Update volume mounts in Docker: ./implementations/python./sdks/python

For documentation:

  • All references to implementations/python/sdks/python/
  • All references to typescript-sdk/sdks/typescript/

✅ Verification

  • All files moved successfully
  • Documentation updated with new paths
  • Docker configs updated
  • Migration guide added in sdks/README.md
  • Update script included: update-paths.ps1
  • No functionality changes (pure refactor)

📚 Related

This change was implemented on 3 branches with typescript-sdk:


Review checklist:

  • Structure makes sense
  • All path references updated
  • Documentation is clear
  • No broken imports/references

…tations/python into sdks/ folder

BREAKING CHANGE: SDK paths have changed:
- typescript-sdk/ -> sdks/typescript/
- implementations/python/ -> sdks/python/

This improves project organization by grouping all SDK implementations under a common sdks/ directory.
Update all documentation and configuration files to reference new SDK locations:
- implementations/python -> sdks/python
- typescript-sdk -> sdks/typescript
Add comprehensive documentation for the new sdks/ directory structure including:
- Overview of Python and TypeScript SDKs
- Quick start guides for both SDKs
- Migration notice for breaking path changes
- Guidelines for adding new language SDKs
Copilot AI review requested due to automatic review settings January 15, 2026 06:46

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR implements a comprehensive SDK reorganization, moving both TypeScript and Python SDKs into a unified sdks/ directory structure. The change improves organization and scalability by grouping all SDK implementations at the same hierarchy level.

Changes:

  • Restructured repository from typescript-sdk/ and implementations/python/ to sdks/typescript/ and sdks/python/
  • Updated 11 documentation files with new path references
  • Added migration script (update-paths.ps1) to help developers update local references
  • Introduced new TypeScript SDK implementation with runtime and memory layers
  • Added comprehensive test suites for both SDKs

Reviewed changes

Copilot reviewed 13 out of 196 changed files in this pull request and generated no comments.

Show a summary per file
File Description
update-paths.ps1 PowerShell script to automate path updates across documentation and configuration files
sdks/typescript/turbo.json Turbo monorepo configuration for TypeScript SDK build pipeline
sdks/typescript/packages/core/tsconfig.json TypeScript compiler configuration for core package
sdks/typescript/packages/core/src/runtime.ts ARAL Runtime (L1) implementation with lifecycle management and health checks
sdks/typescript/packages/core/src/runtime.test.ts Comprehensive test suite for runtime functionality
sdks/typescript/packages/core/src/memory.ts ARAL Memory (L2) with TTL support and GDPR compliance
sdks/typescript/packages/core/src/memory.test.ts Test suite for memory layer including GDPR features
sdks/typescript/packages/core/src/index.ts Main entry point exporting runtime and memory modules
sdks/typescript/packages/core/package.json Updated repository directory path
sdks/typescript/package.json Monorepo root package configuration
sdks/typescript/package-lock.json Complete dependency lock file (4276 lines)
sdks/python/tests/test_secure_reasoning.py New test suite for secure reasoning engine with injection mitigation
sdks/python/tests/test_runtime.py New test suite for Python runtime implementation
sdks/python/examples/README.md Updated path reference from implementations/python to sdks/python
sdks/python/docs/quickstart.rst Updated installation and example paths
sdks/python/docs/migration.rst Updated test reference path
sdks/python/docs/examples.rst Updated example file path
sdks/python/docs/api/reasoning.rst New API documentation for reasoning layer

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants