Skip to main content

SDK for interacting with Zimasa medical systems

Project description

zmbus-sdk

A Python SDK for interacting with Zimasa medical systems. This library simplifies integration with Zimasa's healthcare APIs, allowing developers to easily access and manage medical data, patient records, and healthcare services.

Installation

You can install the package directly from PyPI:

pip install zmbus-sdk

For development installation:

# Clone the repository
git clone https://github.com/shikoli-makatiani/zimabus-sdk.git
cd zimabus-sdk

# Install with Poetry
poetry install

Quick Start

from zimasabus_sdk import zmsystem

# Initialize the client with your credentials
client = zmsystem.ZMSystem(
    api_key="your_api_key",
    base_url="https://api.zimasa.com/v1"
)

# Example: Get patient information
patient = client.get_patient(patient_id="12345")
print(f"Patient Name: {patient.full_name}")

# Example: Submit medical records
response = client.submit_medical_record(
    patient_id="12345",
    record_data={
        "diagnosis": "Hypertension",
        "treatment": "Prescribed medication",
        "notes": "Follow-up in 2 weeks"
    }
)

Features

  • Secure Authentication: Easy API authentication with your Zimasa credentials
  • Patient Management: Create, retrieve, update, and manage patient records
  • Medical Data: Access and submit medical records, test results, and diagnoses
  • Appointment Scheduling: Manage healthcare appointments and schedules
  • Data Validation: Built-in validation for all API requests using Pydantic
  • Error Handling: Comprehensive error handling with detailed error messages

Documentation

For detailed documentation and API reference, visit our documentation site.

Development

This project uses Poetry for dependency management.

# Install dependencies
poetry install

# Run tests
poetry run pytest

# Format code
poetry run black zimasabus_sdk
poetry run isort zimasabus_sdk

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.

Support

For support, please contact shikoli@turnkeyafrica.com or open an issue on GitHub.

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

zmbus_sdk-0.1.1.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zmbus_sdk-0.1.1-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file zmbus_sdk-0.1.1.tar.gz.

File metadata

  • Download URL: zmbus_sdk-0.1.1.tar.gz
  • Upload date:
  • Size: 5.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.7 Windows/11

File hashes

Hashes for zmbus_sdk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f11587123c07b4535eaf782a2af4ff99cf74f894bd2b3f97c28bd53b031b8067
MD5 fa67397365a08a1a870e52913faed9bc
BLAKE2b-256 5c4af313e0be3cfdfeb7c0606661416ded97e7d99ddef49adac0959a74c591e3

See more details on using hashes here.

File details

Details for the file zmbus_sdk-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: zmbus_sdk-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 6.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.7 Windows/11

File hashes

Hashes for zmbus_sdk-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6a45d25ba6275c62a25e27418c02612b0b6d641570967c333b02039ee98c8d0a
MD5 6e2e5abb6e6388208c236500afbdde3f
BLAKE2b-256 220b590d210550b033a36e5b2566f9794e0bce38fead02de66402992a28b2803

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