open-mpic-core 6.0.0

Library of core (common) MPIC functionality for Open MPIC in Python.

open-mpic-core-python

A Python implementation of the Open MPIC core library which can be adapted to various transports or deployment environments.

Overview

The open-mpic-core library is a "common code" or "core" library for Open MPIC, written in Python. It is designed to be included in Python projects that wrap this code in something that can be invoked to leverage it.

For example:

• The aws-lambda-python GitHub project utilizes this library as part of an AWS Lambda-based MPIC implementation.
• The open-mpic-containers GitHub project uses this library to implement the key MPIC components (coordinator, CAA checker, DCV checker) as FastAPI-based Docker images that can be deployed as desired.

API Specification

The open-mpic-core library utilizes object definitions which are based on the Open MPIC API Specification. This codebase is versioned to correspond to the Open MPIC API Specification version on which it is based. MPIC implementations based on this library should therefore be expected to conform to the corresponding Open MPIC API specification.

Installation

To include the open-mpic-core library in your project, add it as a dependency in your pyproject.toml file:

[project]
dependencies = [
  "open-mpic-core"
]

Alternatively, you can install it using pip:

pip install open-mpic-core

Usage

Here is an example of how to use the open-mpic-core library in your project:

from open_mpic_core.mpic_caa_checker import MpicCaaChecker
from open_mpic_core.common_domain import CaaCheckRequest, CaaCheckResponse

# Create a CAA check request
caa_request = CaaCheckRequest(
    caa_check_parameters=...  # Fill in the required parameters
)

# Perform the CAA check
checker = MpicCaaChecker()
caa_response = await checker.check_caa(caa_request)

# Process the response
if caa_response.check_passed:
    print("CAA check passed")
else:
    print("CAA check failed")

Contributing

Contributions are welcome! Please see the contributing guidelines for more information.

License

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

Links

• Documentation
• Issues
• Source

Authors

• Henry Birge-Lee
• Grace Cimaszewski
• Dmitry Sharkov