@graphysdk/data-import-utils 1.8.1-beta.1787065194945 → 1.8.1-beta.1787131914625
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.
- package/README.md +12 -22
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,25 +1,20 @@
|
|
|
1
|
-
#
|
|
1
|
+
# @graphysdk/data-import-utils
|
|
2
2
|
|
|
3
|
-
Parse CSV, TSV, JSON, and spreadsheet files into the `{ columns, rows }`
|
|
3
|
+
Parse CSV, TSV, JSON, and spreadsheet files into the `{ columns, rows }` shape used by Graphy charts and agents.
|
|
4
4
|
|
|
5
|
-
##
|
|
6
|
-
|
|
7
|
-
- [Data Import overview](https://docs.graphy.dev/data-import-utils)
|
|
8
|
-
- [Examples](https://docs.graphy.dev/data-import-utils/examples)
|
|
9
|
-
- [Agents SDK](https://docs.graphy.dev/agents/sdk/installation) — feed parsed data into `@graphysdk/agents-sdk`
|
|
10
|
-
|
|
11
|
-
## Installation
|
|
5
|
+
## Install
|
|
12
6
|
|
|
13
7
|
```bash
|
|
14
|
-
|
|
8
|
+
npm install @graphysdk/data-import-utils
|
|
15
9
|
```
|
|
16
10
|
|
|
17
|
-
|
|
11
|
+
## Docs
|
|
12
|
+
|
|
13
|
+
- [Overview](https://docs.graphy.dev/data-import-utils)
|
|
14
|
+
- [Examples](https://docs.graphy.dev/data-import-utils/examples)
|
|
18
15
|
|
|
19
16
|
## Usage
|
|
20
17
|
|
|
21
|
-
### Parse a file from disk
|
|
22
|
-
|
|
23
18
|
```ts
|
|
24
19
|
import { fromFile } from '@graphysdk/data-import-utils/file';
|
|
25
20
|
|
|
@@ -27,18 +22,13 @@ const data = await fromFile('sales.csv');
|
|
|
27
22
|
const spreadsheet = await fromFile('report.xlsx', { sheet: 'Revenue' });
|
|
28
23
|
```
|
|
29
24
|
|
|
30
|
-
### Parse from a URL
|
|
31
|
-
|
|
32
25
|
```ts
|
|
33
26
|
import { fromURL } from '@graphysdk/data-import-utils/url';
|
|
34
27
|
|
|
35
28
|
const data = await fromURL('https://example.com/sales.csv');
|
|
36
|
-
const spreadsheet = await fromURL('https://example.com/report.xlsx', { sheet: 'Revenue' });
|
|
37
29
|
```
|
|
38
30
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
Each format has a dedicated entrypoint so you only bundle what you need:
|
|
31
|
+
Each format also has its own entry, so you only bundle what you need:
|
|
42
32
|
|
|
43
33
|
```ts
|
|
44
34
|
import { fromCSV } from '@graphysdk/data-import-utils/csv';
|
|
@@ -48,7 +38,7 @@ import { fromXLS } from '@graphysdk/data-import-utils/xls';
|
|
|
48
38
|
import { fromODS } from '@graphysdk/data-import-utils/ods';
|
|
49
39
|
```
|
|
50
40
|
|
|
51
|
-
|
|
41
|
+
## With the Agents SDK
|
|
52
42
|
|
|
53
43
|
```ts
|
|
54
44
|
import { fromFile } from '@graphysdk/data-import-utils/file';
|
|
@@ -63,9 +53,9 @@ const result = await ai.generateGraph({
|
|
|
63
53
|
});
|
|
64
54
|
```
|
|
65
55
|
|
|
66
|
-
##
|
|
56
|
+
## Formats
|
|
67
57
|
|
|
68
|
-
| Format | Function | Input
|
|
58
|
+
| Format | Function | Input |
|
|
69
59
|
| ------ | ------------ | ------------- |
|
|
70
60
|
| CSV | `fromCSV()` | `string` |
|
|
71
61
|
| TSV | `fromTSV()` | `string` |
|