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

Uploaded Source

Built Distribution

welkin-0.0.7-py3-none-any.whl (41.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for welkin-0.0.7.tar.gz
Algorithm Hash digest
SHA256 ef547d2ab9dfd5c29663a4e50bc83be42c55c18be126ffbe57c6668a6dc73891
MD5 abca727349d3ad9429a6411cdab1583b
BLAKE2b-256 cc8713106b1e7602903cefd49fba6e9362da6c831afd2048122590c32b32fca1

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for welkin-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 6817d372eac590ac5840f40b0f28955bfa6baabe4932517ebad1c2a42f0ccfc7
MD5 17598db87fae8ed315f9961e20ab4667
BLAKE2b-256 b03f4caf257eb7a4e0e4b7453f0eeea7c1865789e5c19f7a1a86b6e63c4ce9c7

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