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.7.tar.gz (28.6 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.7-py3-none-any.whl (36.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for welkin-0.1.7.tar.gz
Algorithm Hash digest
SHA256 f4b952d97d11c0193f752f7f40571b78bc5e63b5c5b0e582e2b35957b6b76e22
MD5 b8176529ad5eec036b681d149db89b86
BLAKE2b-256 df69d7a633a4246e11a2486fd68e0f86596e717896416e66f76877a9d6b1db0b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for welkin-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 d91ca1f4d91d4041b58e50476aa5a418f335345c21b3383ffada0dee19d5c0c4
MD5 9bc5dcba5646c57a79e7af8167f7e5d2
BLAKE2b-256 26b4f61c1c0b2e35f7b93cf46ebab2ec732cef8d58191ad6902092db5708d271

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