The SirixDB Python SDK
Project description
sirix-python-client
The home of the SirixDB python client
This package is currently in alpha stage.
The python client supports both sync and async programs.
The api docs can be found here. The api docs can also be built locally with the following:
cd docs
make html
Some example code:
from pysirix import sirix_sync, DBType, Insert
from httpx import Client
client = Client(base_url="http://localhost:9443")
sirix = sirix_sync("admin", "admin", client)
db = sirix.database("json-diff", DBType.JSON)
db.create()
resource = db.resource("json-resource")
resource.create(
{
"foo": ["bar", None, 2.33],
"bar": {"hello": "world", "helloo": True},
"baz": "hello",
"tada": [{"foo": "bar"}, {"baz": False}, "boo", {}, []],
}
)
resource.update(4, {"new": "stuff"}, insert=Insert.RIGHT)
Or with Async Support:
from pysirix import sirix_async, DBType, Insert
from httpx import AsyncClient
import asyncio
async def main():
client = AsyncClient(base_url="http://localhost:9443")
sirix = await sirix_async("admin", "admin", client)
db = sirix.database("json-diff", DBType.JSON)
await db.create()
resource = db.resource("json-resource")
await resource.create(
{
"foo": ["bar", None, 2.33],
"bar": {"hello": "world", "helloo": True},
"baz": "hello",
"tada": [{"foo": "bar"}, {"baz": False}, "boo", {}, []],
}
)
await resource.update(4, {"new": "stuff"}, insert=Insert.RIGHT)
loop = asyncio.get_event_loop()
loop.run_until_complete(asyncio.run(main()))
pysirix-shell
Installing
If you are not installing pysirix as part of a project, the preferred install method is to use pipx:
pipx install pysirix
Configuring
In your home directory, create a folder named pysirix-shell
, and create a file named config.json
in this folder. This file will hold the configuration for the shell. It should have the following form:
{
"localhost": {
"url": "http://localhost:9443",
"username": "admin",
"timeout": 4
},
"cloud": {
"url": "https://sirix-demo.com:9443",
"username": "administrator"
}
}
The timeout field is optional, and defaults to 5 (seconds).
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pysirix-0.5.3.tar.gz
(25.0 kB
view hashes)
Built Distribution
pysirix-0.5.3-py3-none-any.whl
(29.1 kB
view hashes)