Vital Python Library
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!
Release files for vital 2.1.569
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| vital-2.1.569.tar.gz | 248.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| vital-2.1.569-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 940.8 kB
Release files / vital-2.1.569.tar.gz
| Download URL | vital-2.1.569.tar.gz |
|---|---|
| Size | 248.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
003cf628338c0cc74825544da654ac14aeddcd835f9e1ca236a3fd331020fc07
|
|
BLAKE2b-256 checksum How to use checksums |
669a50cb2d95ada6314b90d3e79f2960474543801f10fed456ae4672fbce9283
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.9.25 Linux/6.11.0-1018-azure
|
Release files / vital-2.1.569-py3-none-any.whl
| Download URL | vital-2.1.569-py3-none-any.whl |
|---|---|
| Size | 692.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fce954bc8656c79e3103942f8e46e4f874f0bf7334c286ae6b2b8c06487aa1e2
|
|
BLAKE2b-256 checksum How to use checksums |
74680fff12c2d2a3e25710025fc9c519c86c85dc072795f73b30f74de387eea7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.5.1 CPython/3.9.25 Linux/6.11.0-1018-azure
|
