Skip to main content

Python Welkin Health API Wrapper.

Project description

welkin-health

A Python wrapper of the Welkin Health API

Version Python License: GPL v3 Tests codecov

This package allows Python developers to write software that makes use of the Welkin Health API. Functions available in the API are mirrored in this package as closely as possible, translating JSON responses to Python objects. You can find the current documentation for the Welkin Health API here:

Welkin Health API Documentation

Installing

pip install welkin

Quick Start

from welkin import Client

welkin = Client(
    tenant="gh",
    instance="sb-demo",
    api_client="VBOPNRYRWJIP",
    secret_key="+}B{KGTG6#zG%P;tQm0C",
)


### Patient methods
patient = welkin.Patient(firstName="Foo", lastName="Bar").create()  # Create

patient = welkin.Patient(id="6801d498-26f4-4aee-961b-5daffcf193c8").get()  # Read
patients = welkin.Patients().get()  # Read all/list

patient.update(firstName="Baz")  # Update
patient.delete()  # Delete

### User methods
user = client.User(username="bar", email="bar@foo.com").create()  # Create

user = welkin.User(id="301b2895-cbf0-4cac-b4cf-1d082faee95c").get()  # Read
users = welkin.Users().get()  # Read all/list
uasers = welkin.Users().get(
    search="lightmatter", region="east-coast", seat_assigned=True, user_state="ACTIVE"
)  # Filtered read all/list

user.update(firstName="Baz")  # Update
user.delete()  # Delete

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

welkin-0.0.4.tar.gz (24.9 kB view details)

Uploaded Source

Built Distribution

welkin-0.0.4-py3-none-any.whl (27.8 kB view details)

Uploaded Python 3

File details

Details for the file welkin-0.0.4.tar.gz.

File metadata

  • Download URL: welkin-0.0.4.tar.gz
  • Upload date:
  • Size: 24.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for welkin-0.0.4.tar.gz
Algorithm Hash digest
SHA256 99ff8ade7ff98f673d60d16e8f783b2d9a0d18dc0e617af9732bf90ec1e9b27c
MD5 46eeeec359395d747aace80395800b98
BLAKE2b-256 b78e2c8c2eb253cb849cdbdf522e207eb8e0815dfac2b87a8d3002cf4381d35f

See more details on using hashes here.

File details

Details for the file welkin-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: welkin-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 27.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for welkin-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8f15bce3e3fe19cc3a34d90e01d5bb777736ed41ffc7bb17d733a3b2a719a49f
MD5 fbcb0fb11b21c48dbf8bc5ee0d1d4d7e
BLAKE2b-256 d4b54ac2fca08c881e33e0ca96c0e99f424c881b02a5aebee1e016924c8fcbec

See more details on using hashes here.

Supported by

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