Python Client for QRonos
Project description
qronos-client
Python client for QRonos
Installation
This package can be installed via pip:
pip install qronos-client
Example Usage
Authentication
from qronos import QRonosClient
# Create client and login
qronos = QRonosClient(host='dev.qronos.xyz')
token, expiry = qronos.login(username='Quentin', password='Rogers')
# Alternatively, if you already have a token
qronos = QRonosClient(host='dev.qronos.xyz', token='ABCDEFGHIJKLMN')
# Logout
qronos.logout(all_tokens=True)
Tracker (Item) Data Import
# Import Tracker (Item) Data
job_id = qronos.tracker_import(
tracker_id=24,
unique_columns=["Part Number", "Weight"],
can_add_item=True,
can_delete_item=False,
data=[{"Part Number": "A1", "Weight": 5}, {"Part Number": "A2", "Weight": 8}],
)
Stage Data Import
# Import Stage Data
job_id = qronos.stage_import(
stage_id=2,
data=[{"Part Number": "A1", "leadtime": 5}, {"Part Number": "A2", "actual": "2020-10-26"}],
)
Stage Data Import by Tracker Stage
# Import Stage Data
job_id = qronos.stage_import(
tracker_stage_id=2,
data=[{"Part Number": "A1", "leadtime": 5}, {"Part Number": "A2", "actual": "2020-10-26"}],
)
Import Status
# Check Status of an Import
status = qronos.import_status(job_id=job_id)
Delete Items
# Delete Items
job_id = qronos.delete_items(
tracker_id=2,
data=["A", "B"],
)
Get Item Attribute Data
- At minimum you must request a
tracker
or aunique_key
/unique_keys
- You cannot request both a
unique_key
andunique_keys
# Get Item Attribute Data by tracker
item_data = qronos.get_item_attributes(
tracker=3,
show_non_mastered=False,
show_mastered=True,
)
# Get Item Attribute Data by unique keys
item_data = qronos.get_item_attributes(
unique_keys=["800000689", "800000726", "800000727"],
show_non_mastered=True,
show_mastered=True,
)
# Get Item Attribute Data by single unique key
item_data = qronos.get_item_attributes(
unique_key="800000689",
show_non_mastered=False,
show_mastered=True,
)
# Get Item Attribute Data by single unique key for only a single tracker
item_data = qronos.get_item_attributes(
unique_key="800000689",
tracker=4,
show_non_mastered=False,
show_mastered=True,
)
Get Item Stage Data
- At minimum you must request a
tracker
or aunique_key
/unique_keys
- You cannot request both a
unique_key
andunique_keys
- You cannot request both a
stage
andstages
- You cannot request both a
tracker_stage
andtracker_stages
- You cannot request a combinations of
stage
andtracker_stage
fields
# Get Item Stage Data for a tracker
stage_data = qronos.get_item_stages(tracker=3)
# Get Item Stage Data by unique keys
stage_data = qronos.get_item_stages(unique_keys=["800000689", "800000726", "800000727"])
# Get Item Stage Data by single unique key but only for a single stage
stage_data = qronos.get_item_stages(
unique_key="800000689",
stage=54,
)
# Get Item Stage Data by single unique key but only for a single tracker stage
stage_data = qronos.get_item_stages(
unique_key="800000689",
tracker_stage=12,
)
# Get Item Stage Data for a list of stages on a certain tracker
stage_data = qronos.get_item_stages(
tracker=4,
stages=[54, 55, 56],
)
# Get Item Stage Data for a list of tracker stages on a certain tracker
stage_data = qronos.get_item_stages(
tracker=4,
tracker_stages=[12, 13, 14],
)
Testing
Please speak with a QRonos Demo Site Admin for credentials in order to run the tests.
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
qronos-client-1.3.0.tar.gz
(4.5 kB
view hashes)
Built Distribution
Close
Hashes for qronos_client-1.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6d8bc2bff11ac3c6a982c230efa0f369a9277c391169cf6895bee0dfd1cff732 |
|
MD5 | 699e6e066f262e8235751086b114c6d7 |
|
BLAKE2b-256 | ed8fb38549047e0d1e48102138a745c4ad95d84cb9da5aa351d3cea9ca62abcf |