Skip to main content

No project description provided

Project description

Vital Python Library

pypi fern shield

The Vital Python library provides access to the Vital API from applications written in Python.

Documentation

API reference documentation is available here.

Installation

Add this dependency to your project's build file:

pip install vital
# or
poetry add vital

Usage

from vital.client import Vital

vital_client = Vital(
  api_key="YOUR_API_KEY",
)

lab_test = vital_client.lab_tests.get('order-id')

print(lab_test)

Please note: To ensure future compatibility, we ask that you avoid exhaustive matching on enum values such as an order’s status. We may introduce new statuses (and other enum values) over time, and code that assumes all current values are exhaustive could break or fail to compile with SDK upgrades.

To stay compatible and benefit from future enhancements, treat unknown values gracefully—for example, by using default cases or limiting checks to only the values your integration depends on.

Async Client

The SDK also exports an async client.

from vital.client import AsyncVital

import asyncio

vital_client = AsyncVital(
  api_key="YOUR_API_KEY",
)

async def get_lab_test() -> None:
    lab_test = vital_client.lab_tests.get('order-id')
    print(lab_test)

asyncio.run(get_lab_test())

Handling Errors

All exceptions thrown by the SDK will sublcass ApiError.

from vital.core import ApiError
from vital import BadRequestError

try:
  vital_client.lab_tests.get('order-id')
except BadRequestError as e:
  # handle bad request error
except APIError as e:
  # handle any api related error

Environments

When you sign up to Vital you get access to two environments, Sandbox and Production.

Environment URLs
production api.tryvital.io
production-eu api.eu.tryvital.io
sandbox api.sandbox.tryvital.io
sandbox-eu api.sandbox.eu.tryvital.io

By default, the SDK uses the production environment. See the snippet below for an example on how ot change the environment.

from vital.client import Vital
from vital.environment import VitalEnvironment

vital_client = Vital(
  api_key="YOUR_API_KEY",
  environment=VitalEnvironment.Sandbox
)

Timeouts

By default, the client is configured to have a timeout of 60 seconds. You can customize this value at client instantiation.

from vital.client import Vital
from vital.environment import VitalEnvironment

vital_client = Vital(
  api_key="YOUR_API_KEY",
  environment=VitalEnvironment.Sandbox,
  timeout=15
)

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!

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

vital-2.1.320.tar.gz (215.7 kB view details)

Uploaded Source

Built Distribution

vital-2.1.320-py3-none-any.whl (641.1 kB view details)

Uploaded Python 3

File details

Details for the file vital-2.1.320.tar.gz.

File metadata

  • Download URL: vital-2.1.320.tar.gz
  • Upload date:
  • Size: 215.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.18 Linux/6.11.0-1018-azure

File hashes

Hashes for vital-2.1.320.tar.gz
Algorithm Hash digest
SHA256 54955692ceec48fd1d90c5da716027fd3fe22928a28fed1715ff0c2addf77d8e
MD5 f622a8715e509dc08343b397fc55c9ef
BLAKE2b-256 079830b2b12a5061ad13285bc3df659d95b6817b6ce4bef2a132a5bd8522c2fa

See more details on using hashes here.

File details

Details for the file vital-2.1.320-py3-none-any.whl.

File metadata

  • Download URL: vital-2.1.320-py3-none-any.whl
  • Upload date:
  • Size: 641.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.18 Linux/6.11.0-1018-azure

File hashes

Hashes for vital-2.1.320-py3-none-any.whl
Algorithm Hash digest
SHA256 824b7602ddb6e8888a0fb13a0e4b5b406f2d5d900dc78f83028f6b8e5473f901
MD5 6dd8d099111a375cc61fad772e071c4c
BLAKE2b-256 2030134b9d5253af610a1219c98fd4f5decf7f9f566140b41fd51c050f3342fe

See more details on using hashes here.

Supported by

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