Metadata-Version: 2.4
Name: aijsondbpy
Version: 0.6.0
Summary: Python wrapper for aijsondb
Home-page: https://github.com/awenzel67/aijsondb-py
Author: Andreas Wenzel
Author-email: awenzel67@gmail.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python
Dynamic: summary

# Python bindings for aijsondb

The idea behind aijsondb is rather simple:

* Use a single json data file as data source.
* Declare the content of json data with json schema.
* Query the data with a JavaScript expression.

Writing a JavaScript expression to query a json data is not very convenient for humans. On the other hand letting an LLM creating the JavaScript expression using the json schema works well.

Thus using aijsondb in an agentic workflow is a good option to "talk with data".

Python package aijsondb is only a wrapper for the [aijsondb](https://github.com/awenzel67/aijsondb) library.

## Installation

aijsondb is available for Linux and Windows.

**Supported Python versions:** Python 3.7 and above are recommended.

```
pip install aijsondb
```

## Usage

Import the package.

```
import aijsondb
```

Load and validate the json data into an in memory data structure.

```
path_data="data/500 KB_V2.json"
path_schema="data/employeeSchemaDescription_V2.json"
aijsondb.init_db(path_data,path_schema)
```

Now you can query the data.
```
res=aijsondb.query_data_javascript("var result=data.employees.length;")
print(res)
```
By convention the root json object is accessible as `data` in the query. Also, the result of the query must be stored in the variable `result`.

The return value is a JSON string containing the result.
