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.8.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.8-py3-none-any.whl (36.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: welkin-0.1.8.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.8.tar.gz
Algorithm Hash digest
SHA256 3c47216d594fe7b7a05c1aaf935dde560d17145519061a89da0d8a2987d8012a
MD5 63613aba7529a17a14139906e752de3e
BLAKE2b-256 6341100033851d8a5fb3432645991948a09cda814e88ded5c0d791f2617d3aa5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: welkin-0.1.8-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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 fde3cd94ce18542ef28173d643bbb23a37e67532fa7421745637b420bb4f1069
MD5 5dbe8b31cce10301b87c6e9659185e19
BLAKE2b-256 c5bbcdf026335edf67c3356f43c2a46c9333767d85f944861a1a40b9eb7a93a1

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