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.1.5.tar.gz (28.9 kB view details)

Uploaded Source

Built Distribution

welkin-0.1.5-py3-none-any.whl (35.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: welkin-0.1.5.tar.gz
  • Upload date:
  • Size: 28.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.2 Linux/6.5.0-1021-azure

File hashes

Hashes for welkin-0.1.5.tar.gz
Algorithm Hash digest
SHA256 c08e88beabfbfbd9b749d20e518133bc039c90d3103eedfb75b3ad055283b9d8
MD5 19afb25387b2f7128028f10cb1ec9783
BLAKE2b-256 f7f03e461378724b47a4637f9a2dfda5dc910194a30f4ec38a30451cf1ea7fa9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: welkin-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 35.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.2 Linux/6.5.0-1021-azure

File hashes

Hashes for welkin-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 c83d04c1c25ee4b654b16741a1561ec69d53fcd7ae9531d10e494fe923750858
MD5 85db6e530e80e7b56367eaf5797ecc60
BLAKE2b-256 a19d52545b12fb97a5f710bef58ace1667456b1af44b58f81ea45332d3966724

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