Skip to main content

Client for NHS England's MESH messaging system

Project description

MESH Client

A Python client for NHS Digital's MESH API.

Release Notes

see CHANGE-LOG for news on major changes

Installation

pip install mesh-client

Example use

from mesh_client import MeshClient, INT_ENDPOINT
# or LIVE_ENDPOINT

with MeshClient(
        INT_ENDPOINT,
    'MYMAILBOX',
    'Password',
    cert=('/etc/certs/cert.pem', '/etc/certs/key.pem')  # Mesh uses SSL, so you'll need some certs
) as client:
    client.handshake()  # It will work without this, but Spine will complain
    message_ids = client.list_messages()
    first_message = client.retrieve_message(message_ids[0])
    print('Subject', first_message.subject)
    print('Message', first_message.read())
    first_message.acknowledge()

    # Alternatively, iterate
    for message in client.iterate_all_messages():
        with message:  # With block will handle acknowledgement
            print('Message', message.read())

    client.send_message('RECIPIENT_MAILBOX', b'Hello World!', subject='Important message')

Testing your application

We recommend using the mesh sandbox have a look at this docker-compose.yml for an example of how to run the sandbox

Guidance for contributors

see CONTRIBUTING

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

Mesh-Client-3.0.11.tar.gz (87.4 kB view details)

Uploaded Source

Built Distribution

Mesh_Client-3.0.11-py2.py3-none-any.whl (22.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file Mesh-Client-3.0.11.tar.gz.

File metadata

  • Download URL: Mesh-Client-3.0.11.tar.gz
  • Upload date:
  • Size: 87.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for Mesh-Client-3.0.11.tar.gz
Algorithm Hash digest
SHA256 f38cb4be5be7a1b2abc4dc68cd145ccc3d0a706281e509d1da1d44a28195a15f
MD5 3e1430be0739dd22c1a54707a656eada
BLAKE2b-256 b3caad0bf49f4899085382a29e3eed21832fb2d6d03e9a94ecf212955443b71e

See more details on using hashes here.

File details

Details for the file Mesh_Client-3.0.11-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for Mesh_Client-3.0.11-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 6fc1d25ebde27fd0151074e0a07b3ef528f5ba60e9242e852d553d74ae1f6958
MD5 2567957db0ebe2d1080de48ebe3afee4
BLAKE2b-256 f8ea1fcbc74aefd5b1e844714c3e9b7ffc7bfa9fcebf9adf6daeb32ddaa5ba2e

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