Skip to content

Commit 8665a08

Browse files
authored
Merge pull request #5462 from continuedev/pe/sdk
feat: re-export a configured `openai` obj from the SDK
2 parents a2ddc7f + 1ed9bfc commit 8665a08

File tree

76 files changed

+12373
-1155
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+12373
-1155
lines changed

packages/continue-sdk/README.md

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,34 @@
22

33
> **⚠️ EXPERIMENTAL: This package is in early development and subject to frequent breaking changes without notice.**
44
5-
This SDK provides programmatic access to Continue's APIs and functionality.
5+
This SDK provides programmatic access to Continue's Hub APIs and functionality.
66

7-
## Status
7+
## Overview
88

9-
This package is currently in early development and is considered **experimental**. It is not recommended for production use. The API surface, functionality, and implementation are subject to change at any time without prior notice or deprecation period.
9+
The Continue SDK is structured into separate language-specific packages, currently with implementations for TypeScript and Python, with more languages planned for the future:
1010

11+
- **TypeScript SDK**: Located in the `/typescript` directory, providing a drop-in replacement for OpenAI's TypeScript client libraries
12+
- **Python SDK**: Located in the `/python` directory, providing a drop-in replacement for OpenAI's Python client libraries
13+
- **Additional languages**: More language implementations are planned to be added in the future
1114

12-
## Development
15+
Each package includes:
16+
17+
1. OpenAPI-generated clients for the Continue Hub API
18+
2. A wrapper layer that exposes a `Continue.from()` method to easily initialize and use Continue assistants with an OpenAI-compatible interface
19+
20+
## For End Users
21+
22+
End users should install the published packages directly:
23+
24+
- For TypeScript/JavaScript: `npm install @continuedev/sdk`
25+
- For Python: `pip install continuedev`
26+
- For other languages: Check back for new language support
27+
28+
Each published package includes its own documentation.
29+
30+
## For Developers
31+
32+
### Development
1333

1434
```bash
1535
# Install dependencies
@@ -20,4 +40,4 @@ npm run generate-client:ALL
2040

2141
# Start Swagger UI for API exploration
2242
npm run swagger-ui
23-
```
43+
```

packages/continue-sdk/openapi-generator-config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"enumPropertyNaming": "UPPERCASE",
55
"apiPackage": "api",
66
"modelPackage": "models",
7-
"npmName": "@continuedev/sdk",
7+
"npmName": "@continuedev/hub-api",
88
"npmVersion": "0.0.1",
99
"withInterfaces": true,
1010
"nullSafeAdditionalProps": true,

0 commit comments

Comments
 (0)