ptbk 0.44.0-22 → 0.46.0-0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +37 -4
  2. package/package.json +3 -7
package/README.md CHANGED
@@ -8,10 +8,32 @@ Library to supercharge your use of large language models
8
8
  [![License of 📖 Prompt book](https://img.shields.io/github/license/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/blob/main/LICENSE)
9
9
  [![Known Vulnerabilities](https://snyk.io/test/github/webgptorg/promptbook/badge.svg)](https://snyk.io/test/github/webgptorg/promptbook)
10
10
  [![Issues](https://img.shields.io/github/issues/webgptorg/promptbook.svg?style=flat)](https://github.com/webgptorg/promptbook/issues)
11
- [![Socket Badge](https://socket.dev/api/badge/npm/package/@promptbook/core)](https://socket.dev/npm/package/@promptbook/core)
11
+ [![Socket Badge](https://socket.dev/api/badge/npm/package/ptbk)](https://socket.dev/npm/package/ptbk)
12
12
 
13
13
  <!--/Badges-->
14
14
 
15
+ ## 📦 Package `ptbk`
16
+
17
+ - Promptbooks are [divided into several](#-packages) packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
18
+ - This package `ptbk` is one part of the promptbook ecosystem.
19
+
20
+ To install this package, run:
21
+
22
+ ```bash
23
+ npm i ptbk
24
+ ```
25
+
26
+ <!-- TODO: -->
27
+
28
+ ---
29
+
30
+ Rest of the documentation is common for **entire promptbook ecosystem**:
31
+
32
+ <!--
33
+ TODO: Probbably remove this section only in packages
34
+ > ⚠ Warning: This library is still in early development.
35
+ -->
36
+
15
37
  ## 🤍 Whitepaper
16
38
 
17
39
  When you have a simple, single prompt for ChatGPT, GPT-4, Anthropic Claude, Google Gemini, Llama 2, or whatever, it doesn't matter how it is integrated. Whether it's the direct calling of a REST API, using the SDK, hardcoding the prompt in the source code, or importing a text file, the process remains the same.
@@ -283,15 +305,26 @@ _Note: We are using [postprocessing functions](#postprocessing-functions) like `
283
305
 
284
306
  ## 📦 Packages
285
307
 
286
- This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook):
308
+ This library is divided into several packages, all are published from [single monorepo](https://github.com/webgptorg/promptbook).
309
+ You can install all of them at once:
310
+
311
+ ```bash
312
+ npm i ptbk
313
+ ```
314
+
315
+ Or you can install them separately:
287
316
 
288
317
  <!--[🔠]-->
289
318
 
319
+ <!-- Add all new -->
320
+
290
321
  - **[@promptbook/core](https://www.npmjs.com/package/@promptbook/core)** - Core of the library, it contains the main logic for promptbooks
291
- - **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
322
+ - **[@promptbook/utils](https://www.npmjs.com/package/@promptbook/utils)** - Utility functions used in the library but also useful for individual use in preprocessing and postprocessing LLM inputs and outputs
292
323
  - _(Not finished)_ **[@promptbook/wizzard](https://www.npmjs.com/package/@promptbook/wizzard)** - Wizard for creating+running promptbooks in single line
293
324
  - **[@promptbook/execute-javascript](https://www.npmjs.com/package/@promptbook/execute-javascript)** - Execution tools for javascript inside promptbooks
294
325
  - **[@promptbook/openai](https://www.npmjs.com/package/@promptbook/openai)** - Execution tools for OpenAI API, wrapper around OpenAI SDK
326
+ - **[@promptbook/langtail](https://www.npmjs.com/package/@promptbook/langtail)** - Execution tools for Langtail API, wrapper around Langtail SDK
327
+ - **[@promptbook/mock](https://www.npmjs.com/package/@promptbook/mock)** - Mocked execution tools for testing the library and saving the tokens
295
328
  - **[@promptbook/remote-client](https://www.npmjs.com/package/@promptbook/remote-client)** - Remote client for remote execution of promptbooks
296
329
  - **[@promptbook/remote-server](https://www.npmjs.com/package/@promptbook/remote-server)** - Remote server for remote execution of promptbooks
297
330
  - **[@promptbook/types](https://www.npmjs.com/package/@promptbook/types)** - Just typescript types used in the library
@@ -639,7 +672,7 @@ TODO:
639
672
  -->
640
673
 
641
674
  <!--
642
- TODO:
675
+ TODO: !
643
676
  ### Promptbooks vs. Langtail
644
677
 
645
678
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ptbk",
3
- "version": "0.44.0-22",
3
+ "version": "0.46.0-0",
4
4
  "description": "Library to supercharge your use of large language models",
5
5
  "private": false,
6
6
  "sideEffects": false,
@@ -34,10 +34,6 @@
34
34
  },
35
35
  "homepage": "https://www.npmjs.com/package/@promptbook/core",
36
36
  "dependencies": {
37
- "lorem-ipsum": "^2.0.8",
38
- "spacetrim": "0.11.20"
39
- },
40
- "main": "./umd/index.umd.js",
41
- "module": "./esm/index.es.js",
42
- "typings": "./esm/typings/_packages/core.index.d.ts"
37
+ "promptbook": "0.46.0-0"
38
+ }
43
39
  }