A client for the scinote API
Project description
SciNote Client
SciNote Client is a Python library for interacting with the SciNote API. This library allows you to programmatically manage SciNote inventories, including creating and managing inventories, columns, items, and more.
Installation
You can install the SciNote Client library directly from its official repository using pip:
pip install scinote-client
Alternatively, if you have the source code, you can install the package locally by running:
pip install -e path/to/scinote-client-source
Note: If you already have the official version installed, please uninstall it before proceeding.
Usage
The library requires 2 environment variables to be configured:
SCINOTE_BASE_URL
- The API endpointSCINOTE_API_KEY
- The API key, generated in the SciNote admin console.
Here's a basic example of how to use the SciNote Client:
import asyncio
from scinote_client.client.api.teams_client import CreateClient
# Initialize the client
teams_client = CreateClient()
# Get a list of teams
teams = asyncio.run(teams_client.get_teams())
for team in teams:
print(team.id)
# Get a list of inventories for a team.
inventories_client = teams_client.inventory_client(teams[0].team_id)
inventories = asyncio.run(inventories_client.get_inventories())
for inventory in inventories:
print(inventory.id)
Documentation
For detailed documentation, please refer to the official documentation.
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
Built Distribution
File details
Details for the file scinote_client-0.8.1.tar.gz
.
File metadata
- Download URL: scinote_client-0.8.1.tar.gz
- Upload date:
- Size: 21.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
1cf5b12262177e3897fd23700254a4265537be3dd3352b2c8e59c89f7f61534c
|
|
MD5 |
c7ac794e3f1cdbcb1eac74840960d0b0
|
|
BLAKE2b-256 |
94786051113b9c837bfa5ff8d4a5bff98c0d0865b799f5326b1a0bd11edcc0ce
|
File details
Details for the file scinote_client-0.8.1-py3-none-any.whl
.
File metadata
- Download URL: scinote_client-0.8.1-py3-none-any.whl
- Upload date:
- Size: 30.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 |
39c37c44f16ee96fcf8d3b173dc4a78e15db00eb5299dfdcdf5008fefdc62df1
|
|
MD5 |
969a5e48a540bb4735621a48cf7f7b4f
|
|
BLAKE2b-256 |
3041d82f99848c0d152ad8cd88ce67450a4a8c77e5dd8981fff68a1236154099
|