Skip to content

Working SDK v1 #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 21, 2024
Merged

Working SDK v1 #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e3e1855
sdk WIP
anthonyjgrove May 21, 2024
66fafd7
type generation from openapi
anthonyjgrove May 21, 2024
aa573e2
fixes
anthonyjgrove May 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions .cspell.json
View file
Open in desktop

This file was deleted.

3 changes: 2 additions & 1 deletion .eslintignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
build
build
src/types/openapi.d.ts
2 changes: 0 additions & 2 deletions .prettierignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1 @@
# package.json is formatted by package managers, so we ignore it here
package.json
build/
2 changes: 0 additions & 2 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
{
"cSpell.userWords": [], // only use words from .cspell.json
"cSpell.enabled": true,
"editor.formatOnSave": true,
"typescript.tsdk": "node_modules/typescript/lib",
"typescript.enablePromptUseWorkspaceTsdk": true,
Expand Down
18 changes: 16 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,21 @@
# @prompt-foundry/typescript-sdk

The Typescript/ JavasScript SDK for the prompt engineering, prompt management, and prompt testing tool.
The TypeScript/ JavasScript prompt engineering, prompt management, and prompt testing tool.

## Installation

`npm install @prompt-foundry/typescript-sdk`
```bash
npm install @prompt-foundry/typescript-sdk
```

## Usage

```typescript
import PromptFoundry from '@prompt-foundry/typescript-sdk'

const pf = new PromptFoundry({
apiKey: '<API_KEY>'
})

const prompt = await pf.getPrompt({ promptId: 'HELLO' })
```
Loading
Loading