SDK for SiaSearch platform API
Project description
Siasearch SDK
Siasearch SDK is a way to programmatically interface with the Siasearch software. It provides an alternative interface to the GUI and allows users to easily query for, view and manipulate the data fetched.
>>> from siasearch import SiaSearch
>>> sia = SiaSearch.login("http://custom-domain.siasearch.de", "user@example.com", "password")
<SiaSearch object with user `user@example.com` connected to `http://custom-domain.siasearch.de`>
>>> cols = sia.columns()
>>> cols
<Columns object containing columns: ['acceleration_level', 'curved_trajectory', 'dataset_name', 'forward_velocity',...
>>> cols.curved_trajectory.levels
["'LEFT_BEND'", "'NO_BEND'", "'RIGHT_BEND'"]
>>> query = sia.query("dataset_name = 'kitti' AND curved_trajectory = 'LEFT_BEND'")
Query("dataset_name = 'kitti' AND curved_trajectory = 'LEFT_BEND'")
>>> sequences = query.all()
>>> sequences
<Sequences class with 54 segments>
Installing siasearch
Siasearch is available on PyPi
pip install siasearch
How to use it?
See docs
Documentation
To generate simple Sphinx documentation you need to install Sphinx package
pip install -U Sphinx
pip install sphinx-rtd-theme
and run:
sphinx-build -b html docs/source docs/build
from the package root folder.
And you would get build html documentation in docs/build
folder.
You can serve it running python -m http.server
from docs/build
folder.
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
siasearch-0.0.7a1.tar.gz
(13.3 kB
view hashes)
Built Distribution
Close
Hashes for siasearch-0.0.7a1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 429baef4ad0f4157c4c5ff0ecae23c4ca4f84f0f2958e6b8c4ceac566e8a8f17 |
|
MD5 | 38377c4b4e72ebdcab0924f921ed1c91 |
|
BLAKE2b-256 | 36b932119dfe998aa34fb6ecbec6ead4525db725dd73902173b640ee2fb8999c |