Skip to main content

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 endpoint
  • SCINOTE_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


Download files

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

Source Distribution

scinote_client-0.9.0.tar.gz (21.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scinote_client-0.9.0-py3-none-any.whl (30.7 kB view details)

Uploaded Python 3

File details

Details for the file scinote_client-0.9.0.tar.gz.

File metadata

  • Download URL: scinote_client-0.9.0.tar.gz
  • Upload date:
  • Size: 21.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for scinote_client-0.9.0.tar.gz
Algorithm Hash digest
SHA256 4205a1bedec00293cb605ce985a27aca02b3a02163338f830afc41681552f5b7
MD5 10c2a95ca292157babf654b6fb3081dc
BLAKE2b-256 2a18587cc5986c2f42c9a1a24b1a5cf30e89fa2f52c7b318edd738dc51facb40

See more details on using hashes here.

File details

Details for the file scinote_client-0.9.0-py3-none-any.whl.

File metadata

  • Download URL: scinote_client-0.9.0-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.7

File hashes

Hashes for scinote_client-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dc6034c9ec7e1d4b4e4e0c3bd7246f1a506adb1185e565e4e8142fe36524f24c
MD5 17ba8bdc12454a68401a9a1fa31019e7
BLAKE2b-256 0a61c18c1f4b64cdd3eb11dd450e18fe03ca2f80ffddbf6715633fa05fa306a1

See more details on using hashes here.

Supported by

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