Metadata-Version: 2.1
Name: akasicdb
Version: 1.0.0
Summary: Python client library for AkasicDB, a Vector-Graph-Relational DBMS based on PostgreSQL
Author: GraphAI Co., Ltd.
License: Apache-2.0
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Requires-Dist: numpy
Requires-Dist: toml>=0.10
Requires-Dist: psycopg[binary]>=3.1
Provides-Extra: sdk
Requires-Dist: akasicdb[sqlalchemy]; extra == "sdk"
Provides-Extra: sqlalchemy
Requires-Dist: SQLAlchemy>=2.0.23; extra == "sqlalchemy"
Provides-Extra: django
Requires-Dist: Django>=4.2; extra == "django"
Provides-Extra: all
Requires-Dist: akasicdb[django,psycopg3,sdk,sqlalchemy]; extra == "all"
Description-Content-Type: text/markdown

# AkasicDB Python Client

<!--
<p align=center>
<a href="https://pypi.org/project/akasicdb/">
  <img src="https://img.shields.io/pypi/v/akasicdb?label=PyPI" alt="trackgit-views" />
</a>
<a href="https://pypi.org/project/akasicdb/">
  <img src="https://img.shields.io/pypi/dm/akasicdb.svg?label=PyPI%20downloads" alt="trackgit-views" />
</a>
<a href="https://pypi.org/project/akasicdb/">
  <img src="https://img.shields.io/badge/Coverage-84%25-yellowgreen.svg" alt="Test Coverage"></img>
</a>
</p>
-->

`akasicdb` is the official Python SDK for [AkasicDB](https://graphai.io/products/akasicdb/).
`akasicdb` supports Django, SQLAlchemy, and Psycopg3.

## Compatibility

The following collection shows AkasicDB versions and recommended `akasicdb` versions:

|AkasicDB version| Recommended `akasicdb` version |
|:--------------:|:-------------------------------:|
| 0.1.\* | 0.1.\* |
| 0.2.\* | 0.2.\* |
| 1.0.\* | 1.0.\* |

## Installation

You can install `akasicdb` via `pip` or `pip3` for Python 3.11+:

```shell
# install with all features
$ pip3 install --extra-index-url https://test.pypi.org/simple "akasicdb[all]"
# basic sdk usage
$ pip3 install --extra-index-url https://test.pypi.org/simple  "akasicdb[sdk]"
```

You can install a specific version of `akasicdb` by:

```shell
$ pip3 install --extra-index-url https://test.pypi.org/simple akasicdb==0.2.0a1.dev1
```

You can upgrade `akasicdb` to the latest version by:

```shell
$ pip3 install --extra-index-url https://test.pypi.org/simple  --upgrade akasicdb
```

## License

Please see [LICENSE](./LICENSE).

## Contact

Please e-mail test-akasicdb [at] graphai [dot] io.

## Acknowledgement

`akasicdb` source code is based on [pgvecto.rs-py](https://github.com/tensorchord/pgvecto.rs-py) and [pgvector-python](https://github.com/pgvector/pgvector-python).
