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

Uploaded Source

Built Distribution

welkin-0.1.6-py3-none-any.whl (36.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: welkin-0.1.6.tar.gz
  • Upload date:
  • Size: 29.2 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.6.tar.gz
Algorithm Hash digest
SHA256 d6f36645f77812247a5de0ddc7e99fbf172cce83f9d330682785ba2448050774
MD5 cd18faf21a998f7d8cb751b1d42b5e48
BLAKE2b-256 6526da4208b757c426bddfb0a26f4585f6321adc0ce0b597bc01d9af0d018e56

See more details on using hashes here.

File details

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

File metadata

  • Download URL: welkin-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 36.1 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 17a95081619e6d1d949e697e7569f8d489b8d777e0ac9948eaa04086cbbccd3b
MD5 cb8deb39bbeb55d17d66ca549f1fcbdc
BLAKE2b-256 0f1e13e42da16b7193f7491c550b2c28e54f84bf422c68abc91ca183f01d09d4

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