|
1 |
| -# litlytics |
| 1 | +# LitLytics |
2 | 2 |
|
3 |
| -To install dependencies: |
| 3 | +**LitLytics** is an affordable, simple analytics platform that leverages LLMs to automate data analysis. |
| 4 | +It was designed to help teams without dedicated data scientists gain insights from their data. |
| 5 | + |
| 6 | +This is a library that allows running pipelines in browser or server environments. |
| 7 | + |
| 8 | +## Installing |
| 9 | + |
| 10 | +Make sure you have npm-compatible package manager installed (e.g. [Bun](https://bun.sh/)). |
| 11 | + |
| 12 | +Then, install LitLytics from [npm](https://npm.com/packages/litlytics) by running following command: |
4 | 13 |
|
5 | 14 | ```bash
|
6 |
| -bun install |
| 15 | +bun add litlytics |
7 | 16 | ```
|
8 | 17 |
|
9 |
| -To run: |
| 18 | +## Using litlytics package to run pipelines |
10 | 19 |
|
11 |
| -```bash |
12 |
| -bun run litlytics.ts |
| 20 | +Once you have library installed, you can run your pipeline configs like shown in [example](./example/run.ts) below: |
| 21 | + |
| 22 | +```javascript |
| 23 | +import { LitLytics, type Pipeline } from '../litlytics'; |
| 24 | +import pipeline from './pipeline.json'; |
| 25 | + |
| 26 | +// create new instance with provider/model of your choice |
| 27 | +const litlytics = new LitLytics({ |
| 28 | + provider: 'openai', |
| 29 | + model: 'gpt-4o-mini', |
| 30 | + key: process.env.OPENAI_API_KEY, |
| 31 | +}); |
| 32 | +// set pipeline config |
| 33 | +litlytics.setPipeline(pipeline); |
| 34 | +// execute pipeline |
| 35 | +const result = await litlytics.runPipeline(); |
| 36 | +// read results |
| 37 | +console.log(result?.results); |
13 | 38 | ```
|
14 | 39 |
|
15 |
| -This project was created using `bun init` in bun v1.1.29. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime. |
| 40 | +## License |
| 41 | +
|
| 42 | +This project is [licensed](/LICENSE.md) under the **GNU Affero General Public License v3.0 (AGPL-3.0)**. |
| 43 | +This license ensures that the software remains free and open, even when used as part of a network service. If you modify or distribute the project (including deploying it as a service), you must also make your changes available under the same license. |
| 44 | +
|
| 45 | +### Commercial/Enterprise Licensing |
| 46 | +
|
| 47 | +If your use case requires a proprietary license (for example, you do not wish to open-source your modifications or need a more flexible licensing arrangement), we offer **commercial and enterprise licenses**. Please [contact us](mailto:[email protected]?subject=LitLytics%20License) to discuss licensing options tailored to your needs. |
0 commit comments