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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

welkin-0.1.9-py3-none-any.whl (36.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: welkin-0.1.9.tar.gz
  • Upload date:
  • Size: 28.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.12.1 Linux/6.17.0-1020-azure

File hashes

Hashes for welkin-0.1.9.tar.gz
Algorithm Hash digest
SHA256 e3c0039d2b832ab07471cf9170ec046d3fc5537bf596db06a6679f79dd8bcf98
MD5 927d6f8f54a5db71c31a6f4f3c8275b5
BLAKE2b-256 709c22ca7802c5695247754d39c92f7243e59c1caa854befa6737ba324027560

See more details on using hashes here.

File details

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

File metadata

  • Download URL: welkin-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 36.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.12.1 Linux/6.17.0-1020-azure

File hashes

Hashes for welkin-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 794cbbada2ce7e3a25ca5a9ef31f2c16568ffe616ba7af6950d5f54388ba8d0a
MD5 c11e81e7935e70429296f74d5032289a
BLAKE2b-256 1553fb2a405468d368fca0366b55548d811d9e009e61e8e3305cb61c90554d56

See more details on using hashes here.

Supported by

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