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

Uploaded Source

Built Distribution

welkin-0.1.1-py3-none-any.whl (33.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: welkin-0.1.1.tar.gz
  • Upload date:
  • Size: 27.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.2 Linux/6.2.0-1011-azure

File hashes

Hashes for welkin-0.1.1.tar.gz
Algorithm Hash digest
SHA256 3c40e84876fd3fa5444cf9a25d8b60593f06a5ccbf42f4278739ed203925fee8
MD5 697c1f8e5be8ed7722568e513ca05bfa
BLAKE2b-256 3137d3cca66405a06fefcd646b5b35257d905a153d7def70c42a004aebed7acc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: welkin-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 33.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.6.1 CPython/3.10.2 Linux/6.2.0-1011-azure

File hashes

Hashes for welkin-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 54cb1b5554e9a2006e477c9a97b1a87ea38ada36ebfad1b51accf46422466d81
MD5 22ea47b48afda24a7a4b99564f46f829
BLAKE2b-256 f52ffe3bc7492a584799a431d8efa1fd82f17a2ffebf79a956de508f81aaaa29

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