Skip to main content

No project description provided

Project description

pysisu

pysisu is a Python package that will query the Sisu API and convert results into a tabular format.

Overview and Example

Take a look at example_usage.py for a simple example.

from pysisu import PySisu
import os

API_KEY = os.environ.get('SISU_API_KEY')
ANALYSIS_ID = 13234

sisu = PySisu(API_KEY)
sisu.run(ANALYSIS_ID)
table = sisu.get_results(ANALYSIS_ID)
table.to_csv()

The API limits its response to 10000 results per response, via pagination. However, there is a flag for auto_paginate that will continuously fetch for any limit you set.

Contributing to protos

Currently (06/21/2022) betterproto only supports optional in beta, so please install the most recent beta version of better proto.

pip install betterproto==2.0.0b4

Follow the install instructions here.

Then to generate the proto api run the following command:

protoc -I . --python_betterproto_out=. api.proto

Local development

python -m pip install -e .
export SISU_API_KEY=<key>

Testing

Setup

python3 -m venv env
python -m pip install -e .
pip install -r requirements-dev.txt

There are example api responses in tests/input_snapshots and there are the expected parsing responses in tests/output_snapshots.

To updated the output snapshots whenever the input snapshots get updated, just run

pytest -k results_output --snapshot-update

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pysisu-0.4.7.tar.gz (40.0 kB view details)

Uploaded Source

Built Distribution

pysisu-0.4.7-py3-none-any.whl (46.4 kB view details)

Uploaded Python 3

File details

Details for the file pysisu-0.4.7.tar.gz.

File metadata

  • Download URL: pysisu-0.4.7.tar.gz
  • Upload date:
  • Size: 40.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for pysisu-0.4.7.tar.gz
Algorithm Hash digest
SHA256 a4d671414622907ab61c5200d9e3e98c4893b158b586a79667ac58c4e778f7ec
MD5 69be3dfc24f4daa930aa05e5d4dce32a
BLAKE2b-256 b99693f0b8ec669574c07def669dfb205c86df81e2a121778bab86b61f8c1ccd

See more details on using hashes here.

File details

Details for the file pysisu-0.4.7-py3-none-any.whl.

File metadata

  • Download URL: pysisu-0.4.7-py3-none-any.whl
  • Upload date:
  • Size: 46.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for pysisu-0.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 12a98bab4f65f399ac111f2270f98c01eaf74b4e0997f91ab9d6998c302c0b81
MD5 6e6257e589e198f00a2c18bc0d6ea95e
BLAKE2b-256 173576b72798cc5bcdde301ab0d4b0500539b4e589ceb8f000353778c4bfc438

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page