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

Uploaded Source

Built Distribution

welkin-0.0.2-py3-none-any.whl (25.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for welkin-0.0.2.tar.gz
Algorithm Hash digest
SHA256 92d66250b4bf0af3309a49b8165f2e69d8ecd03535a0baa208acd7952feab724
MD5 76de0c42f072064cdf406634bd108a04
BLAKE2b-256 6c260cb8d939df172db08ab88b4e6cb3e4c3e3164ec4d1f3ff118c6f61cf54b7

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for welkin-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3901bf87ea465b32f69f51f8d00b4673e8bd1e0ad9a2011474b6aa53f886229a
MD5 313df79e233587ef5023fbdd82cd549d
BLAKE2b-256 3ae044ca06ccd62cf89aaba85aec20ec6b210ee07817dc7ad2b3ef52d31dff74

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